E-Signature

Create Envelope

Create a DRAFT envelope. Nothing is emailed.

The documents are HTML the caller already holds - there is no upload step - which is what makes the whole flow scriptable. expires_in_days counts from creation, NOT from the moment it is sent, so a draft left sitting for a month has already used its window.

post/envelopes

Request

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

subjectstring required

Subject line the signer sees.

messagestring nullable

Covering note in the signing email.

signer_namestring required
signer_emailstring required
signer_contact_idinteger nullable

Link the envelope to a graph8 contact record.

source_typestring nullable

What produced this envelope, e.g. quote. Free-form, and filterable on list.

source_idstring nullable

The producing record's id.

expires_in_daysinteger

How long the signing link stays valid, counted from CREATION rather than from send.

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 3 revisions of this API.