Signing Requests

Partially Update Signing Request

Changed on

Update signing request properties, a single recipient, OR a single field. Cannot update multiple entity types in one request. Cannot update after signing request has been sent, completed, or cancelled, except for a seal swap (see seal_participant). A seal_participant that names a seal answers 404 NOT_FOUND when the seal does not exist or belongs to another company, and 400 SEAL_UNAVAILABLE when the seal is revoked, deleted or not the current version of its lineage, and also when it is limited to a workspace other than the signing request's. These answers are for adding a seal participant and for changing its seal. A seal swap (swap_to_seal_id) answers differently for the new seal: 404 NOT_FOUND when it does not exist, belongs to another company or is limited to a workspace other than the signing request's; 409 SEAL_UNAVAILABLE when it is revoked, deleted or not the current version of its lineage; 400 SEAL_FIELD_REQUIRED when the seal participant has no stamp field on the signing request. Adding a seal participant or changing its seal answers 503 SEALS_DISABLED when organization seals are not enabled. Adding a seal participant requires order (see the order contract). A field that belongs to a seal participant accepts only position and page_number changes; every other key of field, recipient_id included, is ignored.

patch/signing-requests/{id}

Request

Path parameters

idstring uuid required

Signing request ID

Request body

OR
OR
OR

Response

Signing request updated successfully. Response shape depends on what was updated: properties update returns {id, name, template_description, document_url, expiration_hours}; recipient update returns the full recipient object; field update returns the full field object; a seal participant update or swap returns { "seal_participant": <SealParticipantApi> }. Response may include a 'warning' field for email format validation warnings (non-blocking).

OR
object required

Response when updating/creating a recipient

OR
object required

Response when updating/creating a field

OR

Changes

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added to the response body anyOf list for the response status

    • info

      added the new optional request property //

    • info

      added the new optional request property //