Create Template

Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: templateCreate
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

No URL, query, or header parameters.

Request body

TemplateCreateRequestrequired

Content-Type: application/json, multipart/form-data

Properties: filesfile_urlsallow_reassignattachmentscc_rolesclient_idfield_optionsform_field_groupsform_field_rulesform_fields_per_documentmerge_fieldsmessagemetadatasigner_rolessubjecttest_modetitleuse_preexisting_fields

{
  "files": [
    {}
  ],
  "file_urls": [
    "https://example.com/resource"
  ],
  "allow_reassign": false,
  "attachments": [
    {
      "name": "Example Name",
      "required": false,
      "signer_index": 0
    }
  ],
  "cc_roles": [
    {}
  ],
  "client_id": "example-client-id",
  "field_options": {
    "date_format": "MM / DD / YYYY"
  },
  "form_field_groups": [
    {
      "group_id": "example-group-id"
    }
  ]
}

Responses

`200`

TemplateCreateResponseapplication/json

successful operation

Properties: templatewarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "template": {
    "template_id": "example-template-id"
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}