Create Sign Request

UiPath.Box.IntegrationService.Activities.CreateSignRequest

This activity uses the Box Create sign request - POST API to create a sign request.

How it works

To create a sign request via API, the documents used in the process must have template tags. Template tags are a way in which you add data to a base document that is automatically recognized by Box Sign.

To learn how to create templates using tags, see the official Box documentation.

Important: The Create Sign Request activity will only work with documents that have template tags.

In the body of the activity

• Signer Emails - Email address of the signers separated by comma.

  Note: Template tags are assigned in the order in which the email addresses are added to the Signer Emails field and are not the same as the order of signing. If there are more tags on the document than actual signers, those tags won’t be populated. If you add more signers than tags, the extra signers are able to sign the document, but are not directed to the locations in the document, and have the ability to add text, dates, and signatures wherever they want in the document.
• Source File - The unique identifier that represents a file. Click the Find button to open a search window where you can type a file name and retrieve the file ID.
• Parent Folder ID - The unique identifier that represents a folder. This folder cannot be the All Files or root level. Click the Find button to open a search window where you can type a file name and retrieve the corresponding folder ID.
• Email Subject - The subject of the sign request email.
• Email Message - The message to include in the sign request email.
• Days Valid - The number of days after which the quest will automatically expire if not completed.
• Reminders - If set, signers receive reminders to sign a document on day 3, 8, 13, and 18. Reminders are only send to any outstanding signers. This field supports only Boolean values (True, False).
• Sign Request ID - The output ID of the sign request.

Properties

Common

• DisplayName - The display name of the activity. This field supports only strings or String variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.

  • Success - Boolean - Specifies whether the API request was successful.
  • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
  • Message - String - The error message.