Update shared documents for a contact
Update which documents are shared with a contact. This endpoint will:
- Add new document-contact relationships
- Remove existing relationships not in the provided list
- Automatically approve any pending access requests when all requested documents are shared
- Only allows sharing documents that belong to your tenant
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Contact ID
Request Body
application/json
ids*array<>
Array of document IDs to share with the contact. Documents not in this list will be unshared.
Response Body
application/json
curl -X PATCH "https://app.orbiqhq.com/api/v1/contacts/550e8400-e29b-41d4-a716-446655440000/documents" \ -H "Content-Type: application/json" \ -d '{ "ids": [ "550e8400-e29b-41d4-a716-446655440001", "550e8400-e29b-41d4-a716-446655440002", "550e8400-e29b-41d4-a716-446655440003" ] }'{
"ok": true
}Empty
Empty
Empty
Empty
Empty
How is this guide?