Update document status

POST/api/v1/updateDocumentStatus

This endpoint isn’t available for live testing.

curl -X POST 'https://app.quote.cloud/api/v1/updateDocumentStatus?client_id=<your client id>' \
  -H 'Authorization: Bearer <your token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "documentId": "string",
  "status": "sent"
}'

<your token> and <your client id> are placeholders. Get your own

Inputs and body

client_idrequiredYou don’t need to enter this here. In your own code, use the Client ID from your OAuth client. How to get one

Not sure what to enter? Here’s where to find IDs

Request bodyapplication/jsonGenerated from the schema. Replace the placeholder values.

Example response

{
  "data": {
    "status": "success",
    "message": "string"
  }
}

The spec has no example, so this 200 response is generated from the schema. Values are placeholders.

Transition a document to another status

Permission

An OAuth access token with this scope. How to get a token

documents:write_status

Change document status.

Parameters

Not sure what to enter? Here’s where to find IDs.

client_idquery · stringrequired

The Client ID of your OAuth client. It’s public, and goes on every request alongside your access token. Find it in QuoteCloud under Settings → API dashboard → Manage Integrations → OAuth Clients.Length at least 1.

Request body

Sent as application/json.

documentIdstringrequired

statusstringrequired

Statuses accepted by updateDocumentStatus (custom and scheduled_send are excluded).One of sent, opened, signing, signing_complete, part_paid, paid, accepted, lost, canceled, creating, revising, workflow_review_requested, workflow_review_accepted, pending_sent, delivery_delayed, delivered, alert, email_complained, email_bounced, send_failed, expired, template, system_template.

reasonstring

Free-text reason stored for Lost or Canceled outcomes.Length at most 100.

Responses

200Status updated.

dataobjectrequired

Fields

statusstringrequired

Always success.

messagestringrequired

400Invalid request or validation failure.

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

401Missing or invalid bearer token or client ID.

errorstringrequired

error_descriptionstring

403Insufficient scope, missing add-on, usage limit, or permission denial.

Exactly one of these:

OAuthError

errorstringrequired

error_descriptionstring

ApiErrorEnvelope

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

429Shared company API request quota exceeded. Wait before retrying.

Retry-Afterheader · integer

Minimum seconds to wait before retrying.Value at least 1.

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

retryAfterSecondsintegerrequired

Value at least 1.

Rate limit

120 requests a minute per company, shared across REST, Zapier and MCP. On a 429, wait for Retry-After.