Update access request status
Update the review status of an access request.
When changing status to "approved":
- A magic link email is automatically sent to the contact
- The magic link expires after the configured expiry period (default 7 days)
- You can optionally update the contact's review status in the same request
When changing status to "rejected":
- By default, no email is sent to the contact (send_rejection_email defaults to false)
- You can optionally send a rejection notification email by setting send_rejection_email to true
- The rejection email will include the list of documents that were requested
The contact must belong to an account within your tenant
AuthorizationBearer <token>
In: header
Path Parameters
idstring
Access request ID
Format
uuid
review_statusstring
New review status for the access request
Value in
"to_review" | "in_review" | "approved" | "rejected"
contact_review_status?string
Optional - update the contact's review status at the same time
Value in
"to_review" | "in_review" | "approved" | "rejected"
send_rejection_email?boolean
Optional - when rejecting, send notification email to the contact (defaults to false)
Default
false
Response Body
curl -X PATCH "https://app.orbiqhq.com/api/v1/access-requests/req-123" \ -H "Content-Type: application/json" \ -d '{ "review_status": "approved" }'
{
"success": true,
"data": {
"access_request": {
"id": "req-123",
"review_status": "approved",
"date_updated": "2025-01-15T14:30:00Z"
}
}
}
{
"error": "Access Request ID is required."
}
Empty
{
"error": "Access denied: Access request does not belong to your organization or does not exist."
}
Empty
How is this guide?