signing
signatory

Update a signatory

Changed on
patch/signing/{connection_id}/signatory/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/signing/{connection_id}/signatory/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Signatory

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for this signatory

created_atstring date-time

The date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

document_idstring

Parent signing document; points to SigningDocument

namestring

Full name of the signatory

emailstring

Email address of the signatory

role'SIGNER' | 'CC' | 'APPROVER' | 'IN_PERSON_SIGNER' | 'VIEWER'

Role of the signatory

status'PENDING' | 'SENT' | 'DELIVERED' | 'SIGNED' | 'DECLINED' | 'ERROR'

Current status of this signatory

ordernumber

Signing order (1, 2, 3...)

signed_atstring date-time

When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

decline_reasonstring

Reason for declining (if status is DECLINED)

rawobject

The raw data returned by the integration

Response

Successful

idstring

Unique identifier for this signatory

created_atstring date-time

The date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

document_idstring

Parent signing document; points to SigningDocument

namestring

Full name of the signatory

emailstring

Email address of the signatory

role'SIGNER' | 'CC' | 'APPROVER' | 'IN_PERSON_SIGNER' | 'VIEWER'

Role of the signatory

status'PENDING' | 'SENT' | 'DELIVERED' | 'SIGNED' | 'DECLINED' | 'ERROR'

Current status of this signatory

ordernumber

Signing order (1, 2, 3...)

signed_atstring date-time

When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

decline_reasonstring

Reason for declining (if status is DECLINED)

rawobject

The raw data returned by the integration

Changes

    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status