Create and send an agreement from a docgen template in one call
POST/v1/sign/gen-and-send
Convenience endpoint that combines agreement creation and sending.
Takes a docgen catalog template id (from
POST /v1/docgen/templates/import-from-source), generates a PDF,
creates an agreement with the provided recipients, and sends it.
Routing follows the linked Sign template when present; otherwise,
signing roles sharing one routing order sign in parallel, and distinct
orders sign sequentially. Recipient orders follow their template roles.
Every SIGNER recipient must have a replayed template field.
Request
Responses
- 201
- 400
- 404
- 409
- 500
Agreement created and sent
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Validation error, including TEMPLATE_HAS_NO_SIGNER_FIELDS when a SIGNER recipient has no template fields, or recipient_slot_unmatched when a named signer slot has no matching recipient. No document is created and no signing invitation is sent on this failure.
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Docgen template not found
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Docgen template is archived and can no longer be sent
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Failure preparing or sending the agreement. A failure preparing signing fields does not send signing invitations.
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.