Verdocs - Create Envelope

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

template_id*string

If using a template, the ID of the template to copy

Formatuuid

recipients*array<>

A list of recipients to include in the workflow. Must specify one recipient to match each template Role.

documents?array<>

If not using a template, a list of documents to include in the envelope.

fields?array<>

If not using a template, a list of fields to include in the envelope.

name?string

Override the name of the envelope (defaults to the template name).

description?string

Override the description of the envelope (defaults to the template description).

no_contact?boolean

If set to true, no email or SMS messages will be sent to any recipients.

initial_reminder?integer

Override the template initial-reminder setting in ms.

followup_reminders?integer

Override the template initial-reminder setting in ms.

max_reminder_days?number

Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.

expires_at?string

If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.

Response Body

`application/json`

curl -X POST "https://api.verdocs.com/v2/envelopes" \  -H "Content-Type: application/json" \  -d '{    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",    "recipients": [      {        "first_name": "string",        "role_name": "string",        "type": "string"      }    ]  }'

{
  "canceled_at": "string",
  "created_at": "string",
  "data": "string",
  "documents": "string",
  "expires_at": "string",
  "followup_reminders": "string",
  "id": "string",
  "initial_reminder": "string",
  "max_reminder_days": 0,
  "name": "string",
  "next_reminder": "string",
  "no_contact": true,
  "organization_id": "string",
  "profile_id": "string",
  "sender_email": "string",
  "sender_name": "string",
  "signed": true,
  "status": "string",
  "template_id": "string",
  "updated_at": "string",
  "visibility": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

Create Envelope

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`