Partially Update Signing Request
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.
Authorizations
API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.
Path Parameters
Signing request ID
Body
- Option 1
- Option 2
- Option 3
- Option 4
Update signing request properties only
New name for signing request
255New description
Replace document with new base64-encoded PDF. Page count will be auto-extracted.
New expiration hours
x >= 1Update settings
Opt-in email language for this signing request. When set, all signer-facing emails (and their date formatting) use it. Omit or null to fall back to the workspace, then company, default language (unchanged behavior).
en, es, it, pt, fr, de, el, ru, pl, cs, sv, nl, ro, nb, ca Heading shown on the completion page after signing. Null or an empty string clears the override; omitted leaves it unchanged.
200Body text shown on the completion page after signing. Null or an empty string clears the override; omitted leaves it unchanged.
1000URL the signer is redirected to from the completion page. Must use https:// (http://localhost and http://127.0.0.1 are also accepted on test-mode signing requests). Null or an empty string clears the override; omitted leaves it unchanged.
2000Seconds the completion page waits before redirecting (0 redirects immediately). Only applies when a redirect URL resolves; the page falls back to 5 seconds when no level sets a delay. Null clears the override; omitted leaves it unchanged.
0 <= x <= 30Response
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).