SubFormFieldsPerDocumentTextMerge
{
"allOf": [
{
"$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"default": "text-merge",
"description": "A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class."
},
"font_size": {
"type": "integer",
"default": 12,
"description": "The initial px font size for the field contents. Can be any integer value between `7` and `49`.\n\n**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field."
},
"font_family": {
"enum": [
"helvetica",
"arial",
"courier",
"calibri",
"cambria",
"georgia",
"times",
"trebuchet",
"verdana",
"roboto",
"robotoMono",
"notoSans",
"notoSerif",
"notoCJK-JP-Regular",
"notoHebrew-Regular",
"notoSanThaiMerged"
],
"type": "string",
"description": "Font family for the field."
}
}
},
{
"$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
}
],
"description": "This class extends `SubFormFieldsPerDocumentBase`."
}
SubFormFieldsPerDocumentTypeEnum
{
"enum": [
"checkbox",
"checkbox-merge",
"date_signed",
"dropdown",
"hyperlink",
"initials",
"signature",
"radio",
"text",
"text-merge"
],
"type": "string"
}
SubMergeField
{
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the merge field. Must be unique."
},
"type": {
"enum": [
"text",
"checkbox"
],
"type": "string",
"description": "The type of merge field.",
"x-enumDescriptions": {
"text": "Sets merge [field type](/api/reference/constants/#field-types) to `text`.",
"checkbox": "Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`."
}
}
}
}
SubOAuth
{
"type": "object",
"properties": {
"scopes": {
"type": "array",
"items": {
"enum": [
"request_signature",
"basic_account_info",
"account_access",
"signature_request_access",
"template_access",
"team_access",
"api_app_access",
""
],
"type": "string"
},
"description": "A list of [OAuth scopes](https://raw.githubusercontent.com) to be granted to the app. (Required if `oauth[callback_url]` is provided)."
},
"callback_url": {
"type": "string",
"description": "The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)"
}
},
"description": "OAuth related parameters."
}
SubOptions
{
"type": "object",
"properties": {
"can_insert_everywhere": {
"type": "boolean",
"default": false,
"description": "Determines if signers can use \"Insert Everywhere\" when signing a document."
}
},
"description": "Additional options supported by API App."
}
SubSignatureRequestGroupedSigners
{
"type": "object",
"required": [
"group",
"signers"
],
"properties": {
"group": {
"type": "string",
"description": "The name of the group."
},
"order": {
"type": "integer",
"nullable": true,
"description": "The order the group is required to sign in. Use this instead of Signer-level `order`."
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubSignatureRequestSigner"
},
"description": "Signers belonging to this Group.\n\n**NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below."
}
}
}
SubSignatureRequestSigner
{
"type": "object",
"required": [
"name",
"email_address"
],
"properties": {
"pin": {
"type": "string",
"maxLength": 12,
"minLength": 4,
"description": "The 4- to 12-character access code that will secure this signer's signature page."
},
"name": {
"type": "string",
"description": "The name of the signer."
},
"order": {
"type": "integer",
"nullable": true,
"description": "The order the signer is required to sign in."
},
"email_address": {
"type": "string",
"format": "email",
"description": "The email address of the signer."
},
"sms_phone_number": {
"type": "string",
"description": "An E.164 formatted phone number.\n\nBy using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n**Note**: Not available in test mode and requires a Standard plan or higher."
},
"sms_phone_number_type": {
"enum": [
"authentication",
"delivery"
],
"type": "string",
"description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
}
}
}
SubSignatureRequestTemplateSigner
{
"type": "object",
"required": [
"role",
"name",
"email_address"
],
"properties": {
"pin": {
"type": "string",
"maxLength": 12,
"minLength": 4,
"description": "The 4- to 12-character access code that will secure this signer's signature page."
},
"name": {
"type": "string",
"description": "The name of the signer."
},
"role": {
"type": "string",
"description": "Must match an existing role in chosen Template(s). It's case-sensitive."
},
"email_address": {
"type": "string",
"format": "email",
"description": "The email address of the signer."
},
"sms_phone_number": {
"type": "string",
"description": "An E.164 formatted phone number.\n\nBy using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n**Note**: Not available in test mode and requires a Standard plan or higher."
},
"sms_phone_number_type": {
"enum": [
"authentication",
"delivery"
],
"type": "string",
"description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
}
}
}
SubSigningOptions
{
"type": "object",
"required": [
"default_type"
],
"properties": {
"draw": {
"type": "boolean",
"default": false,
"description": "Allows drawing the signature"
},
"type": {
"type": "boolean",
"default": false,
"description": "Allows typing the signature"
},
"phone": {
"type": "boolean",
"default": false,
"description": "Allows using a smartphone to email the signature"
},
"upload": {
"type": "boolean",
"default": false,
"description": "Allows uploading the signature"
},
"default_type": {
"enum": [
"draw",
"phone",
"type",
"upload"
],
"type": "string",
"description": "The default type shown (limited to the listed types)"
}
},
"description": "This allows the requester to specify the types allowed for creating a signature.\n\n**Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings."
}
SubTeamResponse
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of a team"
},
"team_id": {
"type": "string",
"description": "The id of a team"
}
},
"x-internal": true
}
SubTemplateRole
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name of the signer that will be displayed when the template is used to create a signature request."
},
"order": {
"type": "integer",
"nullable": true,
"description": "The order in which this signer role is required to sign."
}
}
}
SubUnclaimedDraftSigner
{
"type": "object",
"required": [
"name",
"email_address"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the signer."
},
"order": {
"type": "integer",
"nullable": true,
"description": "The order the signer is required to sign in."
},
"email_address": {
"type": "string",
"format": "email",
"description": "The email address of the signer."
}
}
}
SubUnclaimedDraftTemplateSigner
{
"type": "object",
"required": [
"role",
"name",
"email_address"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the signer filling the role of `role`."
},
"role": {
"type": "string",
"description": "Must match an existing role in chosen Template(s)."
},
"email_address": {
"type": "string",
"format": "email",
"description": "The email address of the signer filling the role of `role`."
}
}
}
SubWhiteLabelingOptions
{
"type": "object",
"properties": {
"link_color": {
"type": "string",
"default": "#00B3E6"
},
"text_color1": {
"type": "string",
"default": "#808080"
},
"text_color2": {
"type": "string",
"default": "#FFFFFF"
},
"legal_version": {
"enum": [
"terms1",
"terms2"
],
"type": "string",
"default": "terms1"
},
"reset_to_default": {
"type": "boolean",
"description": "Resets white labeling options to defaults. Only useful when updating an API App."
},
"primary_button_color": {
"type": "string",
"default": "#00B3E6"
},
"page_background_color": {
"type": "string",
"default": "#F7F8F9"
},
"secondary_button_color": {
"type": "string",
"default": "#FFFFFF"
},
"header_background_color": {
"type": "string",
"default": "#1A1A1A"
},
"primary_button_text_color": {
"type": "string",
"default": "#FFFFFF"
},
"primary_button_color_hover": {
"type": "string",
"default": "#00B3E6"
},
"secondary_button_text_color": {
"type": "string",
"default": "#00B3E6"
},
"secondary_button_color_hover": {
"type": "string",
"default": "#FFFFFF"
},
"primary_button_text_color_hover": {
"type": "string",
"default": "#FFFFFF"
},
"secondary_button_text_color_hover": {
"type": "string",
"default": "#00B3E6"
}
},
"description": "An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)\n\nTake a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more."
}
TeamAddMemberRequest
{
"type": "object",
"properties": {
"role": {
"enum": [
"Member",
"Developer",
"Team Manager",
"Admin"
],
"type": "string",
"description": "A role member will take in a new Team.\n\n**Note**: This parameter is used only if `team_id` is provided."
},
"account_id": {
"type": "string",
"description": "`account_id` or `email_address` is required. If both are provided, the account id prevails.\n\nAccount id of the user to invite to your Team."
},
"email_address": {
"type": "string",
"format": "email",
"description": "`account_id` or `email_address` is required, If both are provided, the account id prevails.\n\nEmail address of the user to invite to your Team."
}
}
}
TeamCreateRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "Untitled Team",
"description": "The name of your Team."
}
}
}
TeamGetInfoResponse
{
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/TeamInfoResponse"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"description": "A list of warnings."
}
},
"x-internal": true
}
TeamGetResponse
{
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/TeamResponse"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"description": "A list of warnings."
}
},
"x-internal": true
}
TeamInfoResponse
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of a team"
},
"team_id": {
"type": "string",
"description": "The id of a team"
},
"num_members": {
"type": "integer",
"description": "Number of members within a team"
},
"team_parent": {
"$ref": "#/components/schemas/TeamParentResponse"
},
"num_sub_teams": {
"type": "integer",
"description": "Number of sub teams within a team"
}
},
"x-internal": true
}
TeamInviteResponse
{
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "Role of the user invited to this team."
},
"sent_at": {
"type": "integer",
"description": "Timestamp when the invitation was sent."
},
"team_id": {
"type": "string",
"description": "Id of the team."
},
"expires_at": {
"type": "integer",
"description": "Timestamp when the invitation is expiring."
},
"redeemed_at": {
"type": "integer",
"description": "Timestamp when the invitation was redeemed."
},
"email_address": {
"type": "string",
"description": "Email address of the user invited to this team."
}
},
"x-internal": true
}
TeamInvitesResponse
{
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
}
},
"team_invites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamInviteResponse"
},
"description": "Contains a list of team invites and their roles."
}
},
"x-internal": true
}
TeamMemberResponse
{
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "The specific role a member has on the team."
},
"account_id": {
"type": "string",
"description": "Account id of the team member."
},
"email_address": {
"type": "string",
"description": "Email address of the team member."
}
},
"x-internal": true
}
TeamMembersResponse
{
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
}
},
"list_info": {
"$ref": "#/components/schemas/ListInfoResponse"
},
"team_members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamMemberResponse"
},
"description": "Contains a list of team members and their roles for a specific team."
}
},
"x-internal": true
}
TeamParentResponse
{
"type": "object",
"nullable": true,
"properties": {
"name": {
"type": "string",
"description": "The name of a team"
},
"team_id": {
"type": "string",
"description": "The id of a team"
}
},
"x-internal": true,
"description": "Information about the parent team if a team has one, set to `null` otherwise."
}
TeamRemoveMemberRequest
{
"type": "object",
"properties": {
"new_role": {
"enum": [
"Member",
"Developer",
"Team Manager",
"Admin"
],
"type": "string",
"description": "A new role member will take in a new Team.\n\n**Note**: This parameter is used only if `new_team_id` is provided."
},
"account_id": {
"type": "string",
"description": "**account_id** or **email_address** is required. If both are provided, the account id prevails.\n\nAccount id to remove from your Team."
},
"new_team_id": {
"type": "string",
"description": "Id of the new Team."
},
"email_address": {
"type": "string",
"format": "email",
"description": "**account_id** or **email_address** is required. If both are provided, the account id prevails.\n\nEmail address of the Account to remove from your Team."
},
"new_owner_email_address": {
"type": "string",
"format": "email",
"description": "The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.\n\n**Note**: Only available for Enterprise plans."
}
}
}
TeamResponse
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of your Team"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountResponse"
}
},
"invited_emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account."
},
"invited_accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountResponse"
},
"description": "A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`."
}
},
"x-internal": true,
"description": "Contains information about your team and its members"
}
TeamSubTeamsResponse
{
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
}
},
"list_info": {
"$ref": "#/components/schemas/ListInfoResponse"
},
"sub_teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubTeamResponse"
},
"description": "Contains a list with sub teams."
}
},
"x-internal": true
}
TeamUpdateRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of your Team."
}
}
}
TemplateAddUserRequest
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "The id of the Account to give access to the Template.\n<b>Note</b> The account id prevails if email address is also provided."
},
"email_address": {
"type": "string",
"format": "email",
"description": "The email address of the Account to give access to the Template.\n<b>Note</b> The account id prevails if it is also provided."
},
"skip_notification": {
"type": "boolean",
"default": false,
"description": "If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`."
}
}
}
TemplateCompletelyDeleteResponse
{
"type": "object",
"example": {},
"properties": {}
}
TemplateCreateEmbeddedDraftRequest
{
"type": "object",
"required": [
"client_id"
],
"properties": {
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
},
"title": {
"type": "string",
"description": "The title you want to assign to the SignatureRequest."
},
"message": {
"type": "string",
"maxLength": 5000,
"description": "The default template email message."
},
"subject": {
"type": "string",
"maxLength": 200,
"description": "The template title (alias)."
},
"cc_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "The CC roles that must be assigned when using the template to send a signature request"
},
"metadata": {
"type": "object",
"maxItems": 10,
"description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
"additionalProperties": {}
},
"allow_ccs": {
"type": "boolean",
"default": true,
"description": "This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template."
},
"client_id": {
"type": "string",
"description": "Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app."
},
"file_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
},
"test_mode": {
"type": "boolean",
"default": false,
"description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubAttachment"
},
"description": "A list describing the attachments"
},
"skip_me_now": {
"type": "boolean",
"default": false,
"description": "Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."
},
"merge_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubMergeField"
},
"description": "Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.\nIf the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document."
},
"show_preview": {
"type": "boolean",
"default": false,
"description": "This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."
},
"signer_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubTemplateRole"
},
"description": "An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."
},
"field_options": {
"$ref": "#/components/schemas/SubFieldOptions"
},
"allow_reassign": {
"type": "boolean",
"default": false,
"description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan and higher."
},
"editor_options": {
"$ref": "#/components/schemas/SubEditorOptions"
},
"form_field_rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubFormFieldRule"
},
"description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
},
"form_field_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubFormFieldGroup"
},
"description": "Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."
},
"force_signer_roles": {
"type": "boolean",
"default": false,
"description": "Provide users the ability to review/edit the template signer roles."
},
"force_subject_message": {
"type": "boolean",
"default": false,
"description": "Provide users the ability to review/edit the template subject and message."
},
"show_progress_stepper": {
"type": "boolean",
"default": true,
"description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
},
"use_preexisting_fields": {
"type": "boolean",
"default": false,
"description": "Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`)."
},
"form_fields_per_document": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
},
"description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
}
}
}
TemplateCreateEmbeddedDraftResponse
{
"type": "object",
"properties": {
"template": {
"$ref": "#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"description": "A list of warnings."
}
},
"x-internal": true
}
TemplateCreateEmbeddedDraftResponseTemplate
{
"type": "object",
"properties": {
"edit_url": {
"type": "string",
"description": "Link to edit the template."
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"deprecated": true,
"description": "A list of warnings."
},
"expires_at": {
"type": "integer",
"description": "When the link expires."
},
"template_id": {
"type": "string",
"description": "The id of the Template."
}
},
"x-internal": true,
"description": "Template object with parameters: `template_id`, `edit_url`, `expires_at`."
}
TemplateCreateRequest
{
"type": "object",
"required": [
"signer_roles",
"form_fields_per_document"
],
"properties": {
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
},
"title": {
"type": "string",
"description": "The title you want to assign to the SignatureRequest."
},
"message": {
"type": "string",
"maxLength": 5000,
"description": "The default template email message."
},
"subject": {
"type": "string",
"maxLength": 200,
"description": "The template title (alias)."
},
"cc_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "The CC roles that must be assigned when using the template to send a signature request"
},
"metadata": {
"type": "object",
"maxItems": 10,
"description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
"additionalProperties": {}
},
"client_id": {
"type": "string",
"description": "Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app."
},
"file_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
},
"test_mode": {
"type": "boolean",
"default": false,
"description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubAttachment"
},
"description": "A list describing the attachments"
},
"merge_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubMergeField"
},
"description": "Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.\nIf the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document."
},
"signer_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubTemplateRole"
},
"description": "An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."
},
"field_options": {
"$ref": "#/components/schemas/SubFieldOptions"
},
"allow_reassign": {
"type": "boolean",
"default": false,
"description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan and higher."
},
"form_field_rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubFormFieldRule"
},
"description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
},
"form_field_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubFormFieldGroup"
},
"description": "Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."
},
"use_preexisting_fields": {
"type": "boolean",
"default": false,
"description": "Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`)."
},
"form_fields_per_document": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
},
"description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
}
}
}
TemplateCreateResponse
{
"type": "object",
"properties": {
"template": {
"$ref": "#/components/schemas/TemplateCreateResponseTemplate"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"description": "A list of warnings."
}
},
"x-internal": true
}
TemplateCreateResponseTemplate
{
"type": "object",
"properties": {
"template_id": {
"type": "string",
"description": "The id of the Template."
}
},
"x-internal": true,
"description": "Template object with parameters: `template_id`."
}
TemplateEditResponse
{
"type": "object",
"properties": {
"template_id": {
"type": "string",
"description": "The id of the Template."
}
}
}
TemplateGetFiles200Response
{
"type": "string",
"format": "binary"
}
TemplateGetFilesResponse
{
"type": "string",
"format": "binary"
}
TemplateGetResponse
{
"type": "object",
"properties": {
"template": {
"$ref": "#/components/schemas/TemplateResponse"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"description": "A list of warnings."
}
},
"x-internal": true
}
TemplateListResponse
{
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarningResponse"
},
"description": "A list of warnings."
},
"list_info": {
"$ref": "#/components/schemas/ListInfoResponse"
},
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponse"
},
"description": "List of templates that the API caller has access to."
}
},
"x-internal": true
}
TemplateRemoveUserRequest
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "The id or email address of the Account to remove access to the Template. The account id prevails if both are provided."
},
"email_address": {
"type": "string",
"format": "email",
"description": "The id or email address of the Account to remove access to the Template. The account id prevails if both are provided."
}
}
}
TemplateResponse
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest."
},
"message": {
"type": "string",
"description": "The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest."
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseAccount"
},
"nullable": true,
"description": "An array of the Accounts that can use this Template."
},
"can_edit": {
"type": "boolean",
"nullable": true,
"description": "Indicates whether edit rights have been granted to you by the owner (always `true` if that's you)."
},
"cc_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseCCRole"
},
"description": "An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template."
},
"metadata": {
"type": "object",
"description": "The metadata attached to the template."
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocument"
},
"description": "An array describing each document associated with this Template. Includes form field data for each document."
},
"is_locked": {
"type": "boolean",
"nullable": true,
"description": "Indicates whether the template is locked.\nIf `true`, then the template was created outside your quota and can only be used in `test_mode`.\nIf `false`, then the template is within your quota and can be used to create signature requests."
},
"is_creator": {
"type": "boolean",
"nullable": true,
"description": "`true` if you are the owner of this template, `false` if it's been shared with you by a team member."
},
"updated_at": {
"type": "integer",
"description": "Time the template was last updated."
},
"is_embedded": {
"type": "boolean",
"nullable": true,
"description": "`true` if this template was created using an embedded flow, `false` if it was created on our website."
},
"template_id": {
"type": "string",
"description": "The id of the Template."
},
"signer_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseSignerRole"
},
"description": "An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
},
"nullable": true,
"deprecated": true,
"description": "Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead."
},
"named_form_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
},
"nullable": true,
"deprecated": true,
"description": "Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead."
}
},
"x-internal": true,
"description": "Contains information about the templates you and your team have created."
}
TemplateResponseAccount
{
"type": "object",
"properties": {
"quotas": {
"$ref": "#/components/schemas/TemplateResponseAccountQuota"
},
"is_locked": {
"type": "boolean",
"description": "Returns `true` if the user has been locked out of their account by a team admin."
},
"account_id": {
"type": "string",
"description": "The id of the Account."
},
"is_paid_hf": {
"type": "boolean",
"description": "Returns `true` if the user has a paid HelloFax account."
},
"is_paid_hs": {
"type": "boolean",
"description": "Returns `true` if the user has a paid Dropbox Sign account."
},
"email_address": {
"type": "string",
"description": "The email address associated with the Account."
}
},
"x-internal": true
}
TemplateResponseAccountQuota
{
"type": "object",
"properties": {
"documents_left": {
"type": "integer",
"description": "Signature requests remaining."
},
"templates_left": {
"type": "integer",
"description": "API templates remaining."
},
"sms_verifications_left": {
"type": "integer",
"description": "SMS verifications remaining."
},
"api_signature_requests_left": {
"type": "integer",
"description": "API signature requests remaining."
}
},
"x-internal": true,
"description": "An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template."
}
TemplateResponseCCRole
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Role."
}
},
"x-internal": true
}
TemplateResponseDocument
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the associated file."
},
"index": {
"type": "integer",
"description": "Document ordering, the lowest index is displayed first and the highest last (0-based indexing)."
},
"form_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
},
"description": "An array of Form Field objects containing the name and type of each named field."
},
"field_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocumentFieldGroup"
},
"description": "An array of Form Field Group objects."
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
},
"description": "An array of Form Field objects containing the name and type of each named field."
},
"static_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
},
"nullable": true,
"description": "An array describing static overlay fields. **Note** only available for certain subscriptions."
}
},
"x-internal": true
}
TemplateResponseDocumentCustomFieldBase
{
"type": "object",
"required": [
"type"
],
"properties": {
"x": {
"type": "integer",
"description": "The horizontal offset in pixels for this form field."
},
"y": {
"type": "integer",
"description": "The vertical offset in pixels for this form field."
},
"name": {
"type": "string",
"description": "The name of the Custom Field."
},
"type": {
"type": "string"
},
"group": {
"type": "string",
"nullable": true,
"description": "The name of the group this field is in. If this field is not a group, this defaults to `null`."
},
"width": {
"type": "integer",
"description": "The width in pixels of this form field."
},
"api_id": {
"type": "string",
"description": "The unique ID for this field."
},
"height": {
"type": "integer",
"description": "The height in pixels of this form field."
},
"signer": {
"type": "string",
"nullable": true,
"description": "The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)."
},
"required": {
"type": "boolean",
"description": "Boolean showing whether or not this field is required."
}
},
"x-internal": true,
"description": "An array of Form Field objects containing the name and type of each named field.",
"x-base-class": true,
"discriminator": {
"mapping": {
"text": "#/components/schemas/TemplateResponseDocumentCustomFieldText",
"checkbox": "#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox"
},
"propertyName": "type"
}
}
TemplateResponseDocumentCustomFieldCheckbox
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
},
{
"properties": {
"type": {
"type": "string",
"default": "checkbox",
"description": "The type of this Custom Field. Only `text` and `checkbox` are currently supported.\n\n* Text uses `TemplateResponseDocumentCustomFieldText`\n* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`"
}
}
}
],
"required": [
"type"
],
"description": "This class extends `TemplateResponseDocumentCustomFieldBase`"
}
TemplateResponseDocumentCustomFieldText
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
},
{
"properties": {
"type": {
"type": "string",
"default": "text",
"description": "The type of this Custom Field. Only `text` and `checkbox` are currently supported.\n\n* Text uses `TemplateResponseDocumentCustomFieldText`\n* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`"
},
"fontFamily": {
"type": "string",
"description": "Font family used in this form field's text."
},
"isMultiline": {
"type": "boolean",
"description": "Whether this form field is multiline text."
},
"avg_text_length": {
"$ref": "#/components/schemas/TemplateResponseFieldAvgTextLength"
},
"originalFontSize": {
"type": "integer",
"description": "Original font size used in this form field's text."
}
}
}
],
"required": [
"type"
],
"description": "This class extends `TemplateResponseDocumentCustomFieldBase`"
}