Agnostic Guides
...
docuflow SCRUD Web Services
Box Endpoints
Sign (available version > 6.6.5)
2min
Currently docuflow has an endpoint to create a request to sign documents and send them to multiple users to sign the file.
Note: If the document assigning sign request is in a specific folder under root. Specify the root folder id in box Configuration.
Create a sign request on a document
POST
Request
Body Parameters
id
String
required
Unique id of box file or folder.
type
String
required
Name of metadata template in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
body
Array
required
Json Array of strings (each index being a seperate line).
Or can take a single string value "singleLineExample"
dueDate
String
required
Number of days from today the sign request is valid for. Example: 5
recipients
Array
required
Array of strings of recipients of the task (email id)
*User may require permissions to file before being able to be assigned a sign request.
enableSameDestination
Boolean
optional
If true, signed document and signing log is stored in the same location as source file (destination id auto filledis generated by middleware).
If false, Signed Document and signing log is stored in the destination location.
destinationId
String
required
location where the signed document and signing log is stored (Only when enableSameDestination is false)
taskType
String
required
Task Type of a sign request is "SIGN"
Use case scenario: Store signed document and signing log where orginal document is.
When the enableSameDestination is set to true the signed document and signing log will be stored in the same location as source file (i.e; the parent folder of id)
POST
Request
Body Parameters
id
String
required
Unique id of box file or folder.
type
String
required
Name of metadata template in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
body
Array
required
Json Array of strings (each index being a seperate line).
Or can take a single string value "singleLineExample"
dueDate
String
required
Number of days from today the sign request is valid for.
recipients
Array
required
Array of strings of recipients of the task (email id)
*User may require permissions to file before being able to be assigned a sign request.
enableSameDestination
Boolean
optional
If true, signed document and signing log is stored in the same location as source file (destination id auto filledis generated by middleware).
If false, Signed Document and signing log is stored in the destination location.
destinationId
String
required
location where the signed document and signing log is stored (Only when enableSameDestination is false)
taskType
String
required
Task type of a sign request is "SIGN"
Use case scenario: Multiple Sign Recipients.
The request can be sent to multiple signers. If one signer declines the request the whole request will be cancelled.
POST
Request
Body Parameters
id
String
required
Unique id of box file or folder.
type
String
required
Name of metadata template in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
body
Array
required
Json Array of strings (each index being a seperate line).
Or can take a single string value "singleLineExample"
dueDate
String
required
Number of days from today the sign request is valid for.
recipients
Array
required
Array of strings of recipients of the task (email id)
*User may require permissions to file before being able to be assigned a sign request.
enableSameDestination
Boolean
optional
If true, signed document and signing log is stored in the same location as source file (destination id auto filledis generated by middleware).
If false, Signed Document and signing log is stored in the destination location.
destinationId
String
required
location where the signed document and signing log is stored (Only when enableSameDestination is false)
taskType
String
required
Task Type of a sign request is "SIGN"
Updated 29 Mar 2023
Did this page help you?