Send an order for e-signature

POST/api/v1/orders/{order_id}/esign/send

Create an e-signature envelope for a draft or sent order and email it to the customer contact for signing. The request supplies the document (an https URL or an uploaded s3_key) since order PDFs are rendered client-side. A draft order is moved to sent. Returns 400 when e-signature is not configured, the order is in the wrong status, the customer has no email, or an envelope is already out.

Operation ID: send_order_for_esign_api_v1_orders__order_id__esign_send_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

order_idstringrequired

Request body

Schema: ESignSendRequest

document_urlstringrequired: Document to send for signature: an https URL or an uploaded s3_key (from POST /upload). Required because orders have no backend PDF generator — the caller supplies the rendered order form.
subjectstring: Email subject for the signature request (defaults to one derived from the order number).

Responses

201Successful Response

Schema: SuccessEnvelope_ESignStatusResponse_

successboolean
messagestring
codestring
dataESignStatusResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/orders/{order_id}/esign/send

bash

curl -X POST 'https://api.ondayzero.com/api/v1/orders/{order_id}/esign/send' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "document_url": "string"
}'