dropbox-sign-signatures

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "bulk_send_job_id": {
      "type": "string",
      "description": "The id of the BulkSendJob to retrieve."
    },
    "page": {
      "type": "integer",
      "description": "Which page number of the BulkSendJob list to return. Defaults to `1`."
    },
    "page_size": {
      "type": "integer",
      "description": "Number of objects to be returned per page. Must be between `1` and `100`. Default is 20."
    }
  },
  "required": [
    "PCID",
    "bulk_send_job_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Which page number of the BulkSendJob List to return. Defaults to `1`."
    },
    "page_size": {
      "type": "integer",
      "description": "Number of objects to be returned per page. Must be between `1` and `100`. Default is 20."
    }
  },
  "required": [
    "PCID"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "template_id": {
      "type": "string",
      "description": "The id of the template to edit."
    },
    "allow_edit_ccs": {
      "type": "boolean",
      "description": "This allows the requester to enable/disable to add or change CC roles when editing the template."
    },
    "cc_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request."
    },
    "editor_options": {
      "type": "object",
      "description": "This allows the requester to specify editor options when a preparing a document",
      "properties": {
        "allow_edit_signers": {
          "type": "boolean",
          "description": "Allows requesters to edit the list of signers"
        },
        "allow_edit_documents": {
          "type": "boolean",
          "description": "Allows requesters to edit documents, including delete and add"
        }
      }
    },
    "force_signer_roles": {
      "type": "boolean",
      "description": "Provide users the ability to review/edit the template signer roles."
    },
    "force_subject_message": {
      "type": "boolean",
      "description": "Provide users the ability to review/edit the template subject and message."
    },
    "merge_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the merge field. Must be unique."
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "checkbox"
            ],
            "description": "The type of merge field."
          }
        },
        "required": [
          "name",
          "type"
        ]
      },
      "description": "Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.  Remove all merge fields on the template by passing an empty array `[]`."
    },
    "preview_only": {
      "type": "boolean",
      "description": "This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).  **NOTE:** This parameter overwrites `show_preview=true` (if set)."
    },
    "show_preview": {
      "type": "boolean",
      "description": "This allows the requester to enable the editor/preview experience."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "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."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`."
    }
  },
  "required": [
    "PCID",
    "template_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "signature_id": {
      "type": "string",
      "description": "The id of the signature to get a signature url for."
    }
  },
  "required": [
    "PCID",
    "signature_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "allow_decline": {
      "type": "boolean",
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "ccs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "description": "Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the CC recipient."
          }
        },
        "required": [
          "role",
          "email_address"
        ]
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "editor": {
            "type": "string",
            "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
          },
          "name": {
            "type": "string",
            "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
          },
          "required": {
            "type": "boolean",
            "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
          },
          "value": {
            "type": "string",
            "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "message": {
      "type": "string",
      "description": "The custom message in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "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.  Each 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."
    },
    "signer_file": {
      "type": "string",
      "description": "`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:  - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)      By 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).      **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)      You may only specify field values here, any other options should be set in the custom_fields request parameter.  Example CSV:  ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```"
    },
    "signer_list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "custom_fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the custom field. Must be the field's `name` or `api_id`."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the custom field."
                }
              }
            },
            "description": "An array of custom field values."
          },
          "signers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "role": {
                  "type": "string",
                  "description": "Must match an existing role in chosen Template(s). It's case-sensitive."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the signer."
                },
                "email_address": {
                  "type": "string",
                  "description": "The email address of the signer."
                },
                "pin": {
                  "type": "string",
                  "description": "The 4- to 12-character access code that will secure this signer's signature page."
                },
                "sms_phone_number": {
                  "type": "string",
                  "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
                },
                "sms_phone_number_type": {
                  "type": "string",
                  "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
                }
              }
            },
            "description": "Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.  Currently only templates with a single role are supported. All signers must have the same `role` value."
          }
        }
      },
      "description": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "subject": {
      "type": "string",
      "description": "The subject in the email that will be sent to the signers."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "title": {
      "type": "string",
      "description": "The title you want to assign to the SignatureRequest."
    }
  },
  "required": [
    "PCID",
    "client_id",
    "template_ids"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "allow_decline": {
      "type": "boolean",
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "ccs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "description": "Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the CC recipient."
          }
        },
        "required": [
          "role",
          "email_address"
        ]
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "client_id": {
      "type": "string",
      "description": "The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "editor": {
            "type": "string",
            "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
          },
          "name": {
            "type": "string",
            "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
          },
          "required": {
            "type": "boolean",
            "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
          },
          "value": {
            "type": "string",
            "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "message": {
      "type": "string",
      "description": "The custom message in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "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.  Each 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."
    },
    "signer_file": {
      "type": "string",
      "description": "`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:  - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)      By 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).      **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)      You may only specify field values here, any other options should be set in the custom_fields request parameter.  Example CSV:  ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```"
    },
    "signer_list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "custom_fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the custom field. Must be the field's `name` or `api_id`."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the custom field."
                }
              }
            },
            "description": "An array of custom field values."
          },
          "signers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "role": {
                  "type": "string",
                  "description": "Must match an existing role in chosen Template(s). It's case-sensitive."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the signer."
                },
                "email_address": {
                  "type": "string",
                  "description": "The email address of the signer."
                },
                "pin": {
                  "type": "string",
                  "description": "The 4- to 12-character access code that will secure this signer's signature page."
                },
                "sms_phone_number": {
                  "type": "string",
                  "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
                },
                "sms_phone_number_type": {
                  "type": "string",
                  "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
                }
              }
            },
            "description": "Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.  Currently only templates with a single role are supported. All signers must have the same `role` value."
          }
        }
      },
      "description": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "subject": {
      "type": "string",
      "description": "The subject in the email that will be sent to the signers."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "title": {
      "type": "string",
      "description": "The title you want to assign to the SignatureRequest."
    }
  },
  "required": [
    "PCID",
    "template_ids"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "signature_request_id": {
      "type": "string",
      "description": "The id of the incomplete SignatureRequest to cancel."
    }
  },
  "required": [
    "PCID",
    "signature_request_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "allow_decline": {
      "type": "boolean",
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "allow_reassign": {
      "type": "boolean",
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **NOTE:** Only available for Premium plan."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "instructions": {
            "type": "string",
            "description": "The instructions for uploading the attachment."
          },
          "name": {
            "type": "string",
            "description": "The name of attachment."
          },
          "required": {
            "type": "boolean",
            "description": "Determines if the attachment must be uploaded."
          },
          "signer_index": {
            "type": "integer",
            "description": "The signer's index in the `signers` parameter (0-based indexing).  **NOTE:** Only one signer can be assigned per attachment."
          }
        },
        "required": [
          "name",
          "signer_index"
        ]
      },
      "description": "A list describing the attachments"
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "editor": {
            "type": "string",
            "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
          },
          "name": {
            "type": "string",
            "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
          },
          "required": {
            "type": "boolean",
            "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
          },
          "value": {
            "type": "string",
            "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "expires_at": {
      "type": [
        "integer",
        "null"
      ],
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "field_options": {
      "type": "object",
      "description": "This allows the requester to specify field options for a signature request.",
      "properties": {
        "date_format": {
          "type": "string",
          "description": "Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))  **NOTE:** Only available for Premium and higher.",
          "enum": [
            "MM / DD / YYYY",
            "MM - DD - YYYY",
            "DD / MM / YYYY",
            "DD - MM - YYYY",
            "YYYY / MM / DD",
            "YYYY - MM - DD"
          ]
        }
      },
      "required": [
        "date_format"
      ]
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "group_id": {
            "type": "string",
            "description": "ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`."
          },
          "group_label": {
            "type": "string",
            "description": "Name of the group"
          },
          "requirement": {
            "type": "string",
            "description": "Examples: `require_0-1` `require_1` `require_1-ormore`  - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group."
          }
        },
        "required": [
          "group_id",
          "group_label",
          "requirement"
        ]
      },
      "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`."
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Must be unique across all defined rules."
          },
          "trigger_operator": {
            "type": "string",
            "description": "Currently only `AND` is supported. Support for `OR` is being worked on."
          },
          "triggers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer."
                },
                "operator": {
                  "type": "string",
                  "description": "Different field types allow different `operator` values: - Field type of **text**:   - **is**: exact match   - **not**: not exact match   - **match**: regular expression, without /. Example:     - OK `[a-zA-Z0-9]`     - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**:   - **is**: exact match, single value   - **not**: not exact match, single value   - **any**: exact match, array of values.   - **none**: not exact match, array of values. - Field type of **checkbox**:   - **is**: exact match, single value   - **not**: not exact match, single value - Field type of **radio**:   - **is**: exact match, single value   - **not**: not exact match, single value"
                },
                "value": {
                  "type": "string",
                  "description": "**value** or **values** is required, but not both.  The value to match against **operator**.  - When **operator** is one of the following, **value** must be `String`:   - `is`   - `not`   - `match`  Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`"
                },
                "values": {
                  "type": "array",
                  "description": "**values** or **value** is required, but not both.  The values to match against **operator** when it is one of the following:  - `any` - `none`"
                }
              }
            },
            "description": "An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field_id": {
                  "type": "string",
                  "description": "**field_id** or **group_id** is required, but not both.  Must reference the `api_id` of an existing field defined within `form_fields_per_document`.  Cannot use with `group_id`. Trigger and action fields must belong to the same signer."
                },
                "group_id": {
                  "type": "string",
                  "description": "**group_id** or **field_id** is required, but not both.  Must reference the ID of an existing group defined within `form_field_groups`.  Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer."
                },
                "hidden": {
                  "type": "boolean",
                  "description": "`true` to hide the target field when rule is satisfied, otherwise `false`."
                },
                "type": {
                  "type": "string"
                }
              }
            },
            "description": "An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule."
          }
        },
        "required": [
          "id",
          "trigger_operator",
          "triggers",
          "actions"
        ]
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "document_index": {
            "type": "integer",
            "description": "Represents the integer index of the `file` or `file_url` document the field should be attached to."
          },
          "api_id": {
            "type": "string",
            "description": "An identifier for the field that is unique across all documents in the request."
          },
          "height": {
            "type": "integer",
            "description": "Size of the field in pixels."
          },
          "name": {
            "type": "string",
            "description": "Display name for the field."
          },
          "page": {
            "type": "integer",
            "description": "Page in the document where the field should be placed (requires documents be PDF files).  - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."
          },
          "required": {
            "type": "boolean",
            "description": "Whether this field is required."
          },
          "signer": {
            "type": "string",
            "description": "Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.  **NOTE:** To set the value of the field as the preparer you must set this to `me_now`  **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."
          },
          "type": {
            "type": "string",
            "description": "The type value"
          },
          "width": {
            "type": "integer",
            "description": "Size of the field in pixels."
          },
          "x": {
            "type": "integer",
            "description": "Location coordinates of the field in pixels."
          },
          "y": {
            "type": "integer",
            "description": "Location coordinates of the field in pixels."
          }
        },
        "required": [
          "document_index",
          "api_id",
          "type",
          "required",
          "signer",
          "width",
          "height",
          "x",
          "y"
        ]
      },
      "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](/docs/openapi/form-fields-per-document).)  **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.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "group": {
            "type": "string",
            "description": "The name of the group."
          },
          "order": {
            "type": "integer",
            "description": "The order the group is required to sign in. Use this instead of Signer-level `order`."
          },
          "signers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the signer."
                },
                "email_address": {
                  "type": "string",
                  "description": "The email address of the signer."
                },
                "order": {
                  "type": "integer",
                  "description": "The order the signer is required to sign in."
                },
                "pin": {
                  "type": "string",
                  "description": "The 4- to 12-character access code that will secure this signer's signature page."
                },
                "sms_phone_number": {
                  "type": "string",
                  "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
                },
                "sms_phone_number_type": {
                  "type": "string",
                  "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
                }
              }
            },
            "description": "Signers belonging to this Group.  **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below."
          }
        },
        "required": [
          "group",
          "signers"
        ]
      },
      "description": "Add Grouped Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "hide_text_tags": {
      "type": "boolean",
      "description": "Enables automatic Text Tag removal when set to true.  **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."
    },
    "message": {
      "type": "string",
      "description": "The custom message in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "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.  Each 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."
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "description": "Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.  **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the signer."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the signer."
          },
          "order": {
            "type": "integer",
            "description": "The order the signer is required to sign in."
          },
          "pin": {
            "type": "string",
            "description": "The 4- to 12-character access code that will secure this signer's signature page."
          },
          "sms_phone_number": {
            "type": "string",
            "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
          },
          "sms_phone_number_type": {
            "type": "string",
            "enum": [
              "authentication",
              "delivery"
            ],
            "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
          }
        },
        "required": [
          "name",
          "email_address"
        ]
      },
      "description": "Add Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "type": "object",
      "description": "This allows the requester to specify the types allowed for creating a signature and specify another signing options.  **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.  **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.",
      "properties": {
        "default_type": {
          "type": "string",
          "description": "The default type shown (limited to the listed types)",
          "enum": [
            "draw",
            "phone",
            "type",
            "upload"
          ]
        },
        "draw": {
          "type": "boolean",
          "description": "Allows drawing the signature"
        },
        "phone": {
          "type": "boolean",
          "description": "Allows using a smartphone to email the signature"
        },
        "type": {
          "type": "boolean",
          "description": "Allows typing the signature"
        },
        "upload": {
          "type": "boolean",
          "description": "Allows uploading the signature"
        },
        "force_advanced_signature_details": {
          "type": "boolean",
          "description": "Turning on advanced signature details for the signature request"
        }
      },
      "required": [
        "default_type"
      ]
    },
    "subject": {
      "type": "string",
      "description": "The subject in the email that will be sent to the signers."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "title": {
      "type": "string",
      "description": "The title you want to assign to the SignatureRequest."
    },
    "use_text_tags": {
      "type": "boolean",
      "description": "Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."
    }
  },
  "required": [
    "PCID",
    "client_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "allow_decline": {
      "type": "boolean",
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "ccs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "description": "Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the CC recipient."
          }
        },
        "required": [
          "role",
          "email_address"
        ]
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "editor": {
            "type": "string",
            "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
          },
          "name": {
            "type": "string",
            "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
          },
          "required": {
            "type": "boolean",
            "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
          },
          "value": {
            "type": "string",
            "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "An array defining values and options for custom fields. Required when a custom field exists in the Template."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "message": {
      "type": "string",
      "description": "The custom message in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "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.  Each 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."
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "description": "Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.  **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "description": "Must match an existing role in chosen Template(s). It's case-sensitive."
          },
          "name": {
            "type": "string",
            "description": "The name of the signer."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the signer."
          },
          "pin": {
            "type": "string",
            "description": "The 4- to 12-character access code that will secure this signer's signature page."
          },
          "sms_phone_number": {
            "type": "string",
            "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
          },
          "sms_phone_number_type": {
            "type": "string",
            "enum": [
              "authentication",
              "delivery"
            ],
            "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
          }
        },
        "required": [
          "role",
          "name",
          "email_address"
        ]
      },
      "description": "Add Signers to your Templated-based Signature Request."
    },
    "signing_options": {
      "type": "object",
      "description": "This allows the requester to specify the types allowed for creating a signature and specify another signing options.  **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.  **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.",
      "properties": {
        "default_type": {
          "type": "string",
          "description": "The default type shown (limited to the listed types)",
          "enum": [
            "draw",
            "phone",
            "type",
            "upload"
          ]
        },
        "draw": {
          "type": "boolean",
          "description": "Allows drawing the signature"
        },
        "phone": {
          "type": "boolean",
          "description": "Allows using a smartphone to email the signature"
        },
        "type": {
          "type": "boolean",
          "description": "Allows typing the signature"
        },
        "upload": {
          "type": "boolean",
          "description": "Allows uploading the signature"
        },
        "force_advanced_signature_details": {
          "type": "boolean",
          "description": "Turning on advanced signature details for the signature request"
        }
      },
      "required": [
        "default_type"
      ]
    },
    "subject": {
      "type": "string",
      "description": "The subject in the email that will be sent to the signers."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "title": {
      "type": "string",
      "description": "The title you want to assign to the SignatureRequest."
    }
  },
  "required": [
    "PCID",
    "client_id",
    "signers",
    "template_ids"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "signature_request_id": {
      "type": "string",
      "description": "The id of the SignatureRequest to edit."
    },
    "allow_decline": {
      "type": "boolean",
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "allow_reassign": {
      "type": "boolean",
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **NOTE:** Only available for Premium plan and higher."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "instructions": {
            "type": "string",
            "description": "The instructions for uploading the attachment."
          },
          "name": {
            "type": "string",
            "description": "The name of attachment."
          },
          "required": {
            "type": "boolean",
            "description": "Determines if the attachment must be uploaded."
          },
          "signer_index": {
            "type": "integer",
            "description": "The signer's index in the `signers` parameter (0-based indexing).  **NOTE:** Only one signer can be assigned per attachment."
          }
        },
        "required": [
          "name",
          "signer_index"
        ]
      },
      "description": "A list describing the attachments"
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "client_id": {
      "type": "string",
      "description": "The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "editor": {
            "type": "string",
            "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
          },
          "name": {
            "type": "string",
            "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
          },
          "required": {
            "type": "boolean",
            "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
          },
          "value": {
            "type": "string",
            "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "expires_at": {
      "type": [
        "integer",
        "null"
      ],
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "field_options": {
      "type": "object",
      "description": "This allows the requester to specify field options for a signature request.",
      "properties": {
        "date_format": {
          "type": "string",
          "description": "Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))  **NOTE:** Only available for Premium and higher.",
          "enum": [
            "MM / DD / YYYY",
            "MM - DD - YYYY",
            "DD / MM / YYYY",
            "DD - MM - YYYY",
            "YYYY / MM / DD",
            "YYYY - MM - DD"
          ]
        }
      },
      "required": [
        "date_format"
      ]
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "group_id": {
            "type": "string",
            "description": "ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`."
          },
          "group_label": {
            "type": "string",
            "description": "Name of the group"
          },
          "requirement": {
            "type": "string",
            "description": "Examples: `require_0-1` `require_1` `require_1-ormore`  - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group."
          }
        },
        "required": [
          "group_id",
          "group_label",
          "requirement"
        ]
      },
      "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`."
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Must be unique across all defined rules."
          },
          "trigger_operator": {
            "type": "string",
            "description": "Currently only `AND` is supported. Support for `OR` is being worked on."
          },
          "triggers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer."
                },
                "operator": {
                  "type": "string",
                  "description": "Different field types allow different `operator` values: - Field type of **text**:   - **is**: exact match   - **not**: not exact match   - **match**: regular expression, without /. Example:     - OK `[a-zA-Z0-9]`     - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**:   - **is**: exact match, single value   - **not**: not exact match, single value   - **any**: exact match, array of values.   - **none**: not exact match, array of values. - Field type of **checkbox**:   - **is**: exact match, single value   - **not**: not exact match, single value - Field type of **radio**:   - **is**: exact match, single value   - **not**: not exact match, single value"
                },
                "value": {
                  "type": "string",
                  "description": "**value** or **values** is required, but not both.  The value to match against **operator**.  - When **operator** is one of the following, **value** must be `String`:   - `is`   - `not`   - `match`  Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`"
                },
                "values": {
                  "type": "array",
                  "description": "**values** or **value** is required, but not both.  The values to match against **operator** when it is one of the following:  - `any` - `none`"
                }
              }
            },
            "description": "An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field_id": {
                  "type": "string",
                  "description": "**field_id** or **group_id** is required, but not both.  Must reference the `api_id` of an existing field defined within `form_fields_per_document`.  Cannot use with `group_id`. Trigger and action fields must belong to the same signer."
                },
                "group_id": {
                  "type": "string",
                  "description": "**group_id** or **field_id** is required, but not both.  Must reference the ID of an existing group defined within `form_field_groups`.  Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer."
                },
                "hidden": {
                  "type": "boolean",
                  "description": "`true` to hide the target field when rule is satisfied, otherwise `false`."
                },
                "type": {
                  "type": "string"
                }
              }
            },
            "description": "An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule."
          }
        },
        "required": [
          "id",
          "trigger_operator",
          "triggers",
          "actions"
        ]
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "document_index": {
            "type": "integer",
            "description": "Represents the integer index of the `file` or `file_url` document the field should be attached to."
          },
          "api_id": {
            "type": "string",
            "description": "An identifier for the field that is unique across all documents in the request."
          },
          "height": {
            "type": "integer",
            "description": "Size of the field in pixels."
          },
          "name": {
            "type": "string",
            "description": "Display name for the field."
          },
          "page": {
            "type": "integer",
            "description": "Page in the document where the field should be placed (requires documents be PDF files).  - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."
          },
          "required": {
            "type": "boolean",
            "description": "Whether this field is required."
          },
          "signer": {
            "type": "string",
            "description": "Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.  **NOTE:** To set the value of the field as the preparer you must set this to `me_now`  **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."
          },
          "type": {
            "type": "string",
            "description": "The type value"
          },
          "width": {
            "type": "integer",
            "description": "Size of the field in pixels."
          },
          "x": {
            "type": "integer",
            "description": "Location coordinates of the field in pixels."
          },
          "y": {
            "type": "integer",
            "description": "Location coordinates of the field in pixels."
          }
        },
        "required": [
          "document_index",
          "api_id",
          "type",
          "required",
          "signer",
          "width",
          "height",
          "x",
          "y"
        ]
      },
      "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](/docs/openapi/form-fields-per-document).)  **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.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "group": {
            "type": "string",
            "description": "The name of the group."
          },
          "order": {
            "type": "integer",
            "description": "The order the group is required to sign in. Use this instead of Signer-level `order`."
          },
          "signers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the signer."
                },
                "email_address": {
                  "type": "string",
                  "description": "The email address of the signer."
                },
                "order": {
                  "type": "integer",
                  "description": "The order the signer is required to sign in."
                },
                "pin": {
                  "type": "string",
                  "description": "The 4- to 12-character access code that will secure this signer's signature page."
                },
                "sms_phone_number": {
                  "type": "string",
                  "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
                },
                "sms_phone_number_type": {
                  "type": "string",
                  "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
                }
              }
            },
            "description": "Signers belonging to this Group.  **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below."
          }
        },
        "required": [
          "group",
          "signers"
        ]
      },
      "description": "Add Grouped Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "hide_text_tags": {
      "type": "boolean",
      "description": "Enables automatic Text Tag removal when set to true.  **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."
    },
    "is_eid": {
      "type": "boolean",
      "description": "Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer."
    },
    "message": {
      "type": "string",
      "description": "The custom message in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "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.  Each 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."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the signer."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the signer."
          },
          "order": {
            "type": "integer",
            "description": "The order the signer is required to sign in."
          },
          "pin": {
            "type": "string",
            "description": "The 4- to 12-character access code that will secure this signer's signature page."
          },
          "sms_phone_number": {
            "type": "string",
            "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
          },
          "sms_phone_number_type": {
            "type": "string",
            "enum": [
              "authentication",
              "delivery"
            ],
            "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
          }
        },
        "required": [
          "name",
          "email_address"
        ]
      },
      "description": "Add Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "type": "object",
      "description": "This allows the requester to specify the types allowed for creating a signature and specify another signing options.  **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.  **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.",
      "properties": {
        "default_type": {
          "type": "string",
          "description": "The default type shown (limited to the listed types)",
          "enum": [
            "draw",
            "phone",
            "type",
            "upload"
          ]
        },
        "draw": {
          "type": "boolean",
          "description": "Allows drawing the signature"
        },
        "phone": {
          "type": "boolean",
          "description": "Allows using a smartphone to email the signature"
        },
        "type": {
          "type": "boolean",
          "description": "Allows typing the signature"
        },
        "upload": {
          "type": "boolean",
          "description": "Allows uploading the signature"
        },
        "force_advanced_signature_details": {
          "type": "boolean",
          "description": "Turning on advanced signature details for the signature request"
        }
      },
      "required": [
        "default_type"
      ]
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "subject": {
      "type": "string",
      "description": "The subject in the email that will be sent to the signers."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "title": {
      "type": "string",
      "description": "The title you want to assign to the SignatureRequest."
    },
    "use_text_tags": {
      "type": "boolean",
      "description": "Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."
    }
  },
  "required": [
    "PCID",
    "signature_request_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "signature_request_id": {
      "type": "string",
      "description": "The id of the SignatureRequest to edit."
    },
    "allow_decline": {
      "type": "boolean",
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "allow_reassign": {
      "type": "boolean",
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **NOTE:** Only available for Premium plan."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "instructions": {
            "type": "string",
            "description": "The instructions for uploading the attachment."
          },
          "name": {
            "type": "string",
            "description": "The name of attachment."
          },
          "required": {
            "type": "boolean",
            "description": "Determines if the attachment must be uploaded."
          },
          "signer_index": {
            "type": "integer",
            "description": "The signer's index in the `signers` parameter (0-based indexing).  **NOTE:** Only one signer can be assigned per attachment."
          }
        },
        "required": [
          "name",
          "signer_index"
        ]
      },
      "description": "A list describing the attachments"
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "editor": {
            "type": "string",
            "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
          },
          "name": {
            "type": "string",
            "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
          },
          "required": {
            "type": "boolean",
            "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
          },
          "value": {
            "type": "string",
            "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "expires_at": {
      "type": [
        "integer",
        "null"
      ],
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "field_options": {
      "type": "object",
      "description": "This allows the requester to specify field options for a signature request.",
      "properties": {
        "date_format": {
          "type": "string",
          "description": "Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))  **NOTE:** Only available for Premium and higher.",
          "enum": [
            "MM / DD / YYYY",
            "MM - DD - YYYY",
            "DD / MM / YYYY",
            "DD - MM - YYYY",
            "YYYY / MM / DD",
            "YYYY - MM - DD"
          ]
        }
      },
      "required": [
        "date_format"
      ]
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "group_id": {
            "type": "string",
            "description": "ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`."
          },
          "group_label": {
            "type": "string",
            "description": "Name of the group"
          },
          "requirement": {
            "type": "string",
            "description": "Examples: `require_0-1` `require_1` `require_1-ormore`  - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group."
          }
        },
        "required": [
          "group_id",
          "group_label",
          "requirement"
        ]
      },
      "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`."
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Must be unique across all defined rules."
          },
          "trigger_operator": {
            "type": "string",
            "description": "Currently only `AND` is supported. Support for `OR` is being worked on."
          },
          "triggers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer."
                },
                "operator": {
                  "type": "string",
                  "description": "Different field types allow different `operator` values: - Field type of **text**:   - **is**: exact match   - **not**: not exact match   - **match**: regular expression, without /. Example:     - OK `[a-zA-Z0-9]`     - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**:   - **is**: exact match, single value   - **not**: not exact match, single value   - **any**: exact match, array of values.   - **none**: not exact match, array of values. - Field type of **checkbox**:   - **is**: exact match, single value   - **not**: not exact match, single value - Field type of **radio**:   - **is**: exact match, single value   - **not**: not exact match, single value"
                },
                "value": {
                  "type": "string",
                  "description": "**value** or **values** is required, but not both.  The value to match against **operator**.  - When **operator** is one of the following, **value** must be `String`:   - `is`   - `not`   - `match`  Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`"
                },
                "values": {
                  "type": "array",
                  "description": "**values** or **value** is required, but not both.  The values to match against **operator** when it is one of the following:  - `any` - `none`"
                }
              }
            },
            "description": "An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field_id": {
                  "type": "string",
                  "description": "**field_id** or **group_id** is required, but not both.  Must reference the `api_id` of an existing field defined within `form_fields_per_document`.  Cannot use with `group_id`. Trigger and action fields must belong to the same signer."
                },
                "group_id": {
                  "type": "string",
                  "description": "**group_id** or **field_id** is required, but not both.  Must reference the ID of an existing group defined within `form_field_groups`.  Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer."
                },
                "hidden": {
                  "type": "boolean",
                  "description": "`true` to hide the target field when rule is satisfied, otherwise `false`."
                },
                "type": {
                  "type": "string"
                }
              }
            },
            "description": "An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule."
          }
        },
        "required": [
          "id",
          "trigger_operator",
          "triggers",
          "actions"
        ]
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "document_index": {
            "type": "integer",
            "description": "Represents the integer index of the `file` or `file_url` document the field should be attached to."
          },
          "api_id": {
            "type": "string",
            "description": "An identifier for the field that is unique across all documents in the request."
          },
          "height": {
            "type": "integer",
            "description": "Size of the field in pixels."
          },
          "name": {
            "type": "string",
            "description": "Display name for the field."
          },
          "page": {
            "type": "integer",
            "description": "Page in the document where the field should be placed (requires documents be PDF files).  - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."
          },
          "required": {
            "type": "boolean",
            "description": "Whether this field is required."
          },
          "signer": {
            "type": "string",
            "description": "Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.  **NOTE:** To set the value of the field as the preparer you must set this to `me_now`  **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."
          },
          "type": {
            "type": "string",
            "description": "The type value"
          },
          "width": {
            "type": "integer",
            "description": "Size of the field in pixels."
          },
          "x": {
            "type": "integer",
            "description": "Location coordinates of the field in pixels."
          },
          "y": {
            "type": "integer",
            "description": "Location coordinates of the field in pixels."
          }
        },
        "required": [
          "document_index",
          "api_id",
          "type",
          "required",
          "signer",
          "width",
          "height",
          "x",
          "y"
        ]
      },
      "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](/docs/openapi/form-fields-per-document).)  **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.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "group": {
            "type": "string",
            "description": "The name of the group."
          },
          "order": {
            "type": "integer",
            "description": "The order the group is required to sign in. Use this instead of Signer-level `order`."
          },
          "signers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the signer."
                },
                "email_address": {
                  "type": "string",
                  "description": "The email address of the signer."
                },
                "order": {
                  "type": "integer",
                  "description": "The order the signer is required to sign in."
                },
                "pin": {
                  "type": "string",
                  "description": "The 4- to 12-character access code that will secure this signer's signature page."
                },
                "sms_phone_number": {
                  "type": "string",
                  "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
                },
                "sms_phone_number_type": {
                  "type": "string",
                  "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
                }
              }
            },
            "description": "Signers belonging to this Group.  **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below."
          }
        },
        "required": [
          "group",
          "signers"
        ]
      },
      "description": "Add Grouped Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "hide_text_tags": {
      "type": "boolean",
      "description": "Enables automatic Text Tag removal when set to true.  **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."
    },
    "message": {
      "type": "string",
      "description": "The custom message in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "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.  Each 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."
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "description": "Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.  **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the signer."
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "description": "The email address of the signer."
          },
          "order": {
            "type": "integer",
            "description": "The order the signer is required to sign in."
          },
          "pin": {
            "type": "string",
            "description": "The 4- to 12-character access code that will secure this signer's signature page."
          },
          "sms_phone_number": {
            "type": "string",
            "description": "An E.164 formatted phone number.  By 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).  **NOTE:** Not available in test mode and requires a Standard plan or higher."
          },
          "sms_phone_number_type": {
            "type": "string",
            "enum": [
              "authentication",
              "delivery"
            ],
            "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.  If `authentication`, signer is sent a verification code via SMS that is required to access the document.  If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
          }
        },
        "required": [
          "name",
          "email_address"
        ]
      },
      "description": "Add Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "type": "object",
      "description": "This allows the requester to specify the types allowed for creating a signature and specify another signing options.  **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.  **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.",
      "properties": {
        "default_type": {
          "type": "string",
          "description": "The default type shown (limited to the listed types)",
          "enum": [
            "draw",
            "phone",
            "type",
            "upload"
          ]
        },
        "draw": {
          "type": "boolean",
          "description": "Allows drawing the signature"
        },
        "phone": {
          "type": "boolean",
          "description": "Allows using a smartphone to email the signature"
        },
        "type": {
          "type": "boolean",
          "description": "Allows typing the signature"
        },
        "upload": {
          "type": "boolean",
          "description": "Allows uploading the signature"
        },
        "force_advanced_signature_details": {
          "type": "boolean",
          "description": "Turning on advanced signature details for the signature request"
        }
      },
      "required": [
        "default_type"
      ]
    },
    "subject": {
      "type": "string",
      "description": "The subject in the email that will be sent to the signers."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "title": {
      "type": "string",
      "description": "The title you want to assign to the SignatureRequest."
    },
    "use_text_tags": {
      "type": "boolean",
      "description": "Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."
    }
  },
  "required": [
    "PCID",
    "signature_request_id",
    "client_id"
  ]
}