Skip to main content
PUT
/
api
/
contacts
/
{contactId}
/
documents
/
{documentId}
Update a contact document's type or notes
curl --request PUT \
  --url https://your-instance.example.com/api/contacts/{contactId}/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentType": "Proof of Address",
  "notes": "Updated label after re-review"
}
'
{
  "success": true,
  "document": {
    "_id": "64f0a1b2c3d4e5f6a7b8ca40",
    "storageKey": "org/64f0a1b2c3d4e5f6a7b8c9d3/contact/64f0a1b2c3d4e5f6a7b8c9d0/2026/id-proof.pdf",
    "filename": "id-proof.pdf",
    "contentType": "application/pdf",
    "documentType": "ID Proof"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
contactId
string
required
​
documentId
string
required

Body

application/json
​
documentType
string

New document type label; must match a name configured in the organization's documentTypes.

​
notes
string | null

Free-form note shown alongside the document; pass null to clear an existing note.

Response

Document updated

​
success
enum<boolean>
required
Available options:
true
​
document
object
required
Example:
{
  "_id": "64f0a1b2c3d4e5f6a7b8ca40",
  "storageKey": "org/64f0a1b2c3d4e5f6a7b8c9d3/contact/64f0a1b2c3d4e5f6a7b8c9d0/2026/id-proof.pdf",
  "filename": "id-proof.pdf",
  "contentType": "application/pdf",
  "size": 184320,
  "documentType": "ID Proof",
  "uploadedAt": "2026-05-12T10:00:00.000Z",
  "uploadedBy": "64f0a1b2c3d4e5f6a7b8c9d4",
  "notes": "Driver license, front + back",
  "signedUrl": "https://example-r2.signed/.../id-proof.pdf?X-Amz-Expires=600"
}