Box Sign
Create, manage, and track e-signature requests with Box Sign
Integrate with Box Sign to create and manage e-signature requests. Send documents for signature, track signing status, add multiple signers, set expiration dates, enable reminders, and resend or cancel requests as needed.
| Parameter | Type | Required | Description |
|---|
sourceFileIds | string | Yes | No description |
signerEmail | string | Yes | No description |
signerRole | string | No | No description |
additionalSigners | string | No | JSON array of additional signers, e.g. [{"email":"user@example.com","role":"signer"}] |
parentFolderId | string | No | No description |
emailSubject | string | No | No description |
emailMessage | string | No | No description |
name | string | No | No description |
daysValid | number | No | No description |
areRemindersEnabled | boolean | No | No description |
areTextSignaturesEnabled | boolean | No | No description |
signatureColor | string | No | No description |
redirectUrl | string | No | No description |
declinedRedirectUrl | string | No | No description |
isDocumentPreparationNeeded | boolean | No | No description |
externalId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Sign request ID |
status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Sign request name |
shortId | string | Human-readable short ID |
signers | array | List of signers |
sourceFiles | array | Source files for signing |
emailSubject | string | Custom email subject line |
emailMessage | string | Custom email message body |
daysValid | number | Number of days the request is valid |
createdAt | string | Creation timestamp |
autoExpireAt | string | Auto-expiration timestamp |
prepareUrl | string | URL for document preparation (if preparation is needed) |
senderEmail | string | Email of the sender |
| Parameter | Type | Required | Description |
|---|
signRequestId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Sign request ID |
status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Sign request name |
shortId | string | Human-readable short ID |
signers | array | List of signers |
sourceFiles | array | Source files for signing |
emailSubject | string | Custom email subject line |
emailMessage | string | Custom email message body |
daysValid | number | Number of days the request is valid |
createdAt | string | Creation timestamp |
autoExpireAt | string | Auto-expiration timestamp |
prepareUrl | string | URL for document preparation (if preparation is needed) |
senderEmail | string | Email of the sender |
| Parameter | Type | Required | Description |
|---|
limit | number | No | No description |
marker | string | No | No description |
| Parameter | Type | Description |
|---|
signRequests | array | List of sign requests |
↳ id | string | Sign request ID |
↳ status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
↳ name | string | Sign request name |
↳ shortId | string | Human-readable short ID |
↳ signers | array | List of signers |
↳ sourceFiles | array | Source files for signing |
↳ emailSubject | string | Custom email subject line |
↳ emailMessage | string | Custom email message body |
↳ daysValid | number | Number of days the request is valid |
↳ createdAt | string | Creation timestamp |
↳ autoExpireAt | string | Auto-expiration timestamp |
↳ prepareUrl | string | URL for document preparation (if preparation is needed) |
↳ senderEmail | string | Email of the sender |
count | number | Number of sign requests returned in this page |
nextMarker | string | Marker for next page of results |
| Parameter | Type | Required | Description |
|---|
signRequestId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Sign request ID |
status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Sign request name |
shortId | string | Human-readable short ID |
signers | array | List of signers |
sourceFiles | array | Source files for signing |
emailSubject | string | Custom email subject line |
emailMessage | string | Custom email message body |
daysValid | number | Number of days the request is valid |
createdAt | string | Creation timestamp |
autoExpireAt | string | Auto-expiration timestamp |
prepareUrl | string | URL for document preparation (if preparation is needed) |
senderEmail | string | Email of the sender |
| Parameter | Type | Required | Description |
|---|
signRequestId | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success confirmation message |