documents

Update /documents/{uuid}

Update a document by UUID (PATCH). Only sent fields are updated. Sending assignees or objects replaces the full list. Returns record with the detail projection.

PATCH

/documents/{uuid}

curl --request PATCH \
  --url https://default.hannacrm.app/api/v4/documents/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_to_send_with_sales_docs": "<string>",
  "assignees": [
    "<string>"
  ],
  "category": "<string>",
  "client": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_person": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "date_send": "<string>",
  "description": "<string>",
  "document_date": "<string>",
  "document_number": "<string>",
  "is_asserted_consistently": "<string>",
  "name": "<string>",
  "object": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "objects": [
    "<string>"
  ],
  "opportunity": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receive_date": "<string>",
  "recipient_address": "<string>",
  "registration_number": "<string>",
  "show_to_client": "<string>",
  "status": "<string>",
  "text_description": "<string>",
  "type": "<string>",
  "valid_till": "<string>"
}
'

{
  "record": {
    "allow_to_send_with_sales_docs": "<string>",
    "assignees": [
      {}
    ],
    "category": [
      {}
    ],
    "client": [
      {}
    ],
    "confirmation_status": "<string>",
    "contact_person": [
      {}
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "date_send": "<string>",
    "description": "<string>",
    "document_date": "<string>",
    "document_number": "<string>",
    "is_asserted_consistently": "<string>",
    "name": "<string>",
    "object": [
      {}
    ],
    "objects": [
      {}
    ],
    "opportunity": [
      {}
    ],
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "project": [
      {}
    ],
    "receive_date": "<string>",
    "recipient_address": "<string>",
    "registration_number": "<string>",
    "show_to_client": "<string>",
    "status": [
      {}
    ],
    "text_description": "<string>",
    "type": [
      {}
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>",
    "valid_till": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

allow_to_send_with_sales_docsstring

Allow sending with sales documents.

assigneesstring[]

Responsible person staff UUIDs. On update, replaces the full assignee list when sent.

categorystring

Document category picklist value UUID.

clientstring

Client UUID.

contact_personstring

Contact person UUID.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

date_sendstring

Date send (Y-m-d).

descriptionstring

Description.

document_datestring

Document date (Y-m-d).

document_numberstring

Document number.

is_asserted_consistentlystring

Asserted consistently (e-sign ordering).

namestring

Document title.

objectstring

Related object UUID (legacy single link).

objectsstring[]

Related object UUIDs. On update, replaces the full list when sent.

opportunitystring

Related opportunity UUID.

organizationstring

Organization UUID.

projectstring

Related project UUID.

receive_datestring

Receive date (Y-m-d).

recipient_addressstring

Recipient address.

registration_numberstring

Registration number.

show_to_clientstring

Visible in client portal.

statusstring

Document status picklist value UUID.

text_descriptionstring

Text description / body content.

typestring

Document type picklist value UUID.

valid_tillstring

Valid till date (Y-m-d).

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team

Update /documents/{uuid}

Authorizations

Path Parameters

Body

Response