Create Template

Request

Body Params application/json

name

string

required

Template name

items

array[object (CreateRequestItem) {4}]

required

Items included in the request

name

string

required

Item name. For items with type: Question, the name is used as the question text.

>= 1 characters

type

enum<string>

required

Type of the request item

Allowed values:

UPLOADE_SIGNATUREQUESTION

description

string

optional

Item description

required

boolean

optional

Indicates whether the recipient is required to complete the request item

default_title

string

optional

Default title for request created from template.

personal_message

string

optional

Custom message displayed to recipients when viewing the request

reminders

integer

optional

Interval at which recipients will receive reminder notifications to complete request, measured in days. The default value is three (3) days.

> 0

Default:

3

language

enum<string>

optional

Defaults to English (en).

Allowed values:

en-USesarzhfrdehtheiditkoptparu

Example

{
    "name": "string",
    "items": [
        {
            "name": "string",
            "type": "UPLOAD",
            "description": "string",
            "required": true
        }
    ],
    "default_title": "string",
    "personal_message": "string",
    "reminders": 3,
    "language": "en-US"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/templates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "items": [
        {
            "name": "string",
            "type": "UPLOAD",
            "description": "string",
            "required": true
        }
    ],
    "default_title": "string",
    "personal_message": "string",
    "reminders": 3,
    "language": "en-US"
}'

Responses

🟢200OK

application/json

Successful Response

Body

name

string

required

Template name

id

string

required

owner_id

string

required

Identifier for template owner/manager

items

array[object (RequestItemPublic) {6}]

required

Items included in the request

name

string

required

Item name. For items with type: Question, the name is used as the question text.

id

string

required

type

enum<string>

required

Type of the request item

Allowed values:

UPLOADE_SIGNATUREQUESTION

description

string

optional

Item description

required

boolean

optional

Indicates whether the recipient is required to complete the request item

answer

string

optional

Question answer. Only applies to items with type: QUESTION

default_title

string

optional

Default title for request created from template.

personal_message

string

optional

Custom message displayed to recipients when viewing the request

reminders

string

optional

Interval at which recipients will receive reminder notifications to complete request, measured in days.

language

enum<string>

optional

Defaults to English (en).

Allowed values:

en-USesarzhfrdehtheiditkoptparu

Example

{
    "name": "string",
    "id": "string",
    "owner_id": "string",
    "items": [
        {
            "name": "string",
            "id": "string",
            "type": "UPLOAD",
            "description": "string",
            "required": true,
            "answer": "string"
        }
    ],
    "default_title": "string",
    "personal_message": "string",
    "reminders": "string",
    "language": "en-US"
}

🟠422Parameter Error