Send Envelope
POST /envelopes/{envelope_id}/send
Send the envelope for signature. THIS EMAILS A REAL PERSON.
Not a state change with a side effect - the side effect IS the point: the signer gets a link that carries its own credential, and from that moment the document is in front of somebody outside the organisation.
Tiered external rather than write for exactly that reason.
Authorizations
Parameters
Path Parameters
Envelope id (UUID).
Envelope id (UUID).
Header Parameters
Request Body
Responses
200
Successful Response
object
An open envelope for the envelope detail.
Open on purpose: the detail carries its documents and its whole audit trail, and the audit trail gains event kinds as the product does. Closing it would silently drop an event a caller was relying on to know what happened.
Nothing secret rides in here: the signer and viewer tokens are the SIGNING LINK’s credentials and the app’s detail projection does not include them.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error