Body

• campaignId string Required

  The ID of the campaign you want to use to send a request.

• contact string | object Required

  One of:

  Contact Id string Contact Object object

  Hide attributes Show attributes

  • email string(email)
  • firstName string
  • lastName string
  • company string
  • tag array[string]
  • customFields array[object]
    Hide customFields attributes Show customFields attributes object

    • _id string
    • name string
    • variable string
    • value string
• items array[string]

  An array of itemId. If you want to request only few elements of the campaign, you can optionaly specify which elements you want to include in your request.

• esignDocs array[object]

  Array of documents to be uploaded for e-signature. Each document must be associated with a sign element and can be provided via URL or base64 encoded data. The file size is limited to 20Mb per document regardless of the upload method chosen.

  One of:

  Remote URL object Base64 Data object

  Hide attributes Show attributes

  • itemId string Required

    ID of the sign element you want to upload the document to

  • name string Required

    Name of the file with the file extension

  • url string Required

    URL of the remote file to sign

  Hide attributes Show attributes

  • itemId string Required

    ID of the sign element you want to upload the document to

  • name string Required

    Name of the file with the file extension

  • data string Required

    Base64 encoded file

• esignTriggers array[string]

  ID of sign element that should be triggered for signature immediately after the request is created

• data object

  An object with custom data that you want to use in your request.

  Additional properties are allowed.

• sample object

  An object that represents the sample of a document element. The object must contain 2 parameters: 'itemId' and 'url'.

  Additional properties are allowed.

  Hide sample attributes Show sample attributes object

  • itemId string
  • url string
• dueDate string

  The due date of the request. The due date should be encoded as a string using ISO 8601 format.

• createdBy string

  The ID of the user that is sending the request. This user must have access to the request.

• assignedTo string

  The ID of the team member you want to assign the request to. You can also use the email address of the team member.

• sendMessage boolean

  Boolean. If set to false, the sequence of messages planned in your campaign will not be sent.

• sendCompletionMessage boolean

  Boolean. If set to true, a message will be automatically send when the request status will be changed to "completed". This message can be customized in the branding settings used for this campaign.

• sendRejectionMessage boolean

  Boolean. If set to true, a message will be automatically send when the request status will be changed to "pending" and at least one element on the portal has been rejected. This message can be customized in the branding settings used for this campaign.

• sendReopenMessage boolean

  Boolean. If set to true, a message will be automatically send when the request status will be changed to "pending". This message can be customized in the branding settings used for this campaign.