Company logoTrust Center Documentation
API v1 Reference/Access requests/Id

Update access request status

Update the review status of an access request. When changing status to "approved", an automated email will be sent to the contact with access instructions. The contact must belong to an account within your tenant.

PATCH
/api/v1/access-requests/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Access request (contact) ID

Formatuuid
review_statusstring

New review status for the access request

Value in"to_review" | "in_review" | "approved" | "cancelled"

Response Body

const body = JSON.stringify({
  "review_status": "approved"
})

fetch("https://app.orbiqhq.com/api/v1/access-requests/550e8400-e29b-41d4-a716-446655440000", {
  body
})

{
  "success": true,
  "data": {
    "access_request": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@burgerking.com",
      "review_status": "approved"
    }
  }
}

{
  "success": false,
  "error": "Contact ID is required."
}

Empty
{
  "success": false,
  "error": "Access denied: Contact does not belong to your organization or does not exist."
}
Empty
Empty

How is this guide?