Skip to main content

Cancel Legacy

POST /cancel is the compatibility cancellation endpoint for legacy queue-item posting.
POST /cancel
Use this only for queue items addressed by account_id + content_id.

Request Example

curl -X POST "$PHONEFARM_BASE_URL/cancel" \
  -H "Authorization: Bearer $PHONEFARM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content_id": "content-2026-03-22-001",
    "account_id": "account_user095916355",
    "reason": "video needs re-editing"
  }'

Success Response

{
  "status": "cancelled",
  "queue_item_id": "7c1a07f6-1d55-4f79-a403-8a8420f1b62b",
  "previous_status": "QUEUED"
}

Cancelability Rules

Currently cancellable:
  • QUEUED
  • SCHEDULED
Currently not cancellable:
  • CLAIMED
  • EXECUTING
  • DONE
Non-cancellable states return 409.

Failure Modes

Status codeMeaning
401Missing or invalid bearer token.
404Queue item not found.
409Queue item already in progress or otherwise not cancellable.
422Invalid payload.
500Unexpected cancellation failure.