Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
Document Operations

Update party

<small>Requires an API token with the Document Manager role.</small>

Updates the details of a party on a document.

Note: When updating a party that is linked to an account party (where is_internal_party is true), only reference can be updated. Attempting to update other fields will cause the request to be rejected with a validation error.

put/documents/{document}/parties/{party}

Path parameters

documentstring required

The document UUID

partystring required

The party UUID

Request body

referencestring

A generic reference for the party

entity_namestring nullable

The actual name of the party. i.e. name of the company or person. Must be non-null in order for the document to proceed to the signing stage

addressstring nullable

The party's address

scope'internal' | 'internal_and_external'

Example request

{
  "reference": "Employer",
  "entity_name": "Demo Inc.",
  "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
}

Response

DocumentPartyResource

Example response

{
  "data": {
    "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
    "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reference": "Employer",
    "entity_name": "Demo Inc.",
    "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
    "signatories": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "mobile_phone": "+447951123456",
        "title": "Sales Manager",
        "profile_photo_url": "https://ui-avatars.com/api/?name=EM"
      }
    ]
  }
}