E-Signature

Send Envelope

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.

post/envelopes/{envelope_id}/send

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/envelopes/{envelope_id}/send
  • Auth: HTTP bearer

Path parameters

envelope_idstring required

Envelope id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

custom_messagestring nullable

Overrides the envelope's stored message for this send only.

Response

Successful Response

dataEnvelopePayload required

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.