Verdocs - Create a template

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Template name

description?string

Optional description

visibility?TTemplateVisibility

Visibility setting

Value in"private" | "shared" | "public"

is_personal?boolean

Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)

is_public?boolean

Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)

sender?TTemplateSender

Who may send envelopes using this template

Value in"envelope_creator" | "template_owner"

initial_reminder?number

Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.

followup_reminders?number

Delay (in seconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.

max_reminder_days?number

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

documents?array<>

Optional list of documents to attach to the template

roles?array<>

Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.

fields?array<any>

Optional list of fields to create. Note that if fields that do not match a role will be ignored.

Response Body

`application/json`

curl -X POST "https://api.verdocs.com/v2/templates" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "counter": 0,
  "created_at": "string",
  "data": "string",
  "description": "string",
  "followup_reminders": "string",
  "id": "string",
  "initial_reminder": "string",
  "is_personal": true,
  "is_public": true,
  "is_sendable": true,
  "last_used_at": "string",
  "max_reminder_days": 0,
  "organization_id": "string",
  "profile_id": "string",
  "sender": "string",
  "star_counter": 0,
  "updated_at": "string",
  "visibility": "string"
}

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

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

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

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

Create a template

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`