Company logoTrust Center Documentation
API v1 ReferenceContactsIdDocuments

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
PATCH
/api/v1/contacts/{id}/documents
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Contact ID

idsarray<string>

Array of document IDs to share with the contact. Documents not in this list will be unshared.

Response Body

const body = JSON.stringify({  "ids": [    "doc-123",    "doc-456",    "doc-789"  ]})fetch("https://app.orbiqhq.com/api/v1/contacts/550e8400-e29b-41d4-a716-446655440000/documents", {  method: "PATCH",  headers: {    "Content-Type": "application/json"  },  body})
{
  "ok": true
}
Empty
Empty
Empty
Empty
Empty

How is this guide?