Skip to content
Quarters Developers
esc
  • Type an endpoint, an object or a word from a guide.

Object

AgreementInput

Your whole current view of the envelope.

Fields

FieldTypeDescription
externalId string | nullYour stable id for the envelope (a DocuSeal submission id, say). Required unless status is failed: a failure before any envelope exists, missing fields or an API outage, annotates the current agreement instead.
status requiredenum "sent""completed""declined""failed""voided"
sentAt timestamp | nullDefaults to now the first time the status is reached, and is kept afterwards. ISO 8601
completedAt timestamp | nullAs sentAt. ISO 8601
declinedAt timestamp | nullAs sentAt. ISO 8601
voidedAt timestamp | nullAs sentAt. ISO 8601
error string | nullWhy it failed, for staff to read on the booking. Only kept while status is failed. max 2000 chars
documentUrl url | nullWhere the provider hosts the executed document. Shown to staff as a link. max 2000 charshttps only
signers SignerInput[]Up to ten. Matched by role; a party you leave out is left as it was. max 10default []

Used by

Example

{
  "externalId": "docuseal:1849213",
  "status": "sent",
  "signers": [
    {
      "role": "lessor",
      "name": "City Retreat B.V.",
      "email": "bookings@cityretreat.com",
      "status": "completed"
    },
    {
      "role": "lessee",
      "name": "Sofia Rossi",
      "email": "sofia@example.com",
      "status": "pending",
      "signingUrl": "https://docuseal.com/s/…"
    }
  ]
}