Agnostic Guides
...
Developers Guide
Box Endpoints
Sign (available version > 6.6.5)
2min
Currently Link Enterprise has an endpoint to create a request to sign documents and send them to multiple users to sign the file.
Create a sign request on a document
POST
Request
Form Parameters
Parameter name
optional
String
Body Parameters
id
required
String
Unique id of box file or folder.
type
required
String
Name of metadata template in box.
selectedCMS
required
String
Value should always be set to "box" to let Link Enterprise know which configured content system to search.
body
required
Array
Json Array of strings (each index being a seperate line).
Or can take a single string value "singleLineExample"
dueDate
required
String
Number of days from today the sign request is valid for.
recipients
required
Array
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
optional
Boolean
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
required
String
location where the signed document and signing log is stored (Only when enableSameDestination is false)
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
Form Parameters
Parameter name
optional
String
Body Parameters
id
required
String
Unique id of box file or folder.
type
required
String
Name of metadata template in box.
selectedCMS
required
String
Value should always be set to "box" to let Link Enterprise know which configured content system to search.
body
required
Array
Json Array of strings (each index being a seperate line).
Or can take a single string value "singleLineExample"
dueDate
required
String
Number of days from today the sign request is valid for.
recipients
required
Array
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
optional
Boolean
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
required
String
location where the signed document and signing log is stored (Only when enableSameDestination is false)
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
Form Parameters
Parameter name
optional
String
Body Parameters
id
required
String
Unique id of box file or folder.
type
required
String
Name of metadata template in box.
selectedCMS
required
String
Value should always be set to "box" to let Link Enterprise know which configured content system to search.
body
required
Array
Json Array of strings (each index being a seperate line).
Or can take a single string value "singleLineExample"
dueDate
required
String
Number of days from today the sign request is valid for.
recipients
required
Array
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
optional
Boolean
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
required
String
location where the signed document and signing log is stored (Only when enableSameDestination is false)