Cancel (Unsend) Purchase Order Communication
POST/api/purchase-orders/:purchase_order/communications/:communication/cancel
Unsend an outbound communication that is still within its undo window (delivery_state="scheduled"). Recalls the message so it is never sent, and returns the entry with delivery_state="cancelled".
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Only messages still in the undo window can be unsent. Once the window has elapsed and delivery has started, this returns 422 and the message cannot be recalled.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.