Dispatch E-signature
Dispatch E-signature
/api/public/standalone/dispatch_esignature/v2
Sends a document out for e-signatures at specified time. Default dispatch time is immediately.
Headers
- Content-Type:application/json
- Authorization: Bearer [user key: auth token]
Parameters
| Field | Description | Format |
|---|---|---|
| session_editor_token | A required property that identifies the edit session. This token is provided by the initiate edited session endpoint. |
string |
| when | An optional indicator of the time the e-signature will be dispatched. Default is immediately but we also accept dates. The format must be "+ x [days?|months?|hours?|minutes?|seconds?]" where x is an integer or "Y-m-dTH:i:sZ" where Y - A four digit representation of a year, m - A numeric representation of a month (from 01 to 12), d - The day of the month (from 01 to 31), H - 24-hour format of an hour (00 to 23), i - Minutes with leading zeros (00 to 59),s - Seconds, with leading zeros (00 to 59), and Z - Timezone offset in seconds. The offset for timezones west of UTC is negative (-43200 to 50400) |
string |
A CURL Request
curl -X POST https://docendorse.com/api/public/standalone/dispatch_esignature/v2 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer " \
-d '{
"session_editor_token": "19be7a119e7a4503b6a8d2020cede517",
"when": "immediately"
}'
Response
{
status: string [status of the request]
description: string [describes the result of the request]
}
Error
{
status: error,
description: error message
}