Skip to main content
POST
/
cpl
/
orders
/
{public_id}
/
cancel
Cancel a CPL order.
curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'
{
  "success": true,
  "data": {
    "order_id": "<string>"
  }
}
Cancellation is only available while the order is still queued: status=waiting with queue_position >= 1. Once an order leaves the queue and starts delivery it can no longer be cancelled here.

Authorizations

​
X-API-Key
string
header
required

Your API key from the Studio Dashboard

Path Parameters

​
public_id
string
required

Resource public id. Format varies by endpoint: cplo_xxxxxxx for CPL orders, cpco_xxxxxxx for CPC orders, swpo_xxxxxxx for swap orders, cpcr_xxxxxxx for CPC creatives, revi_xxxxxxx for RevShare invoices.

Pattern: ^[a-z0-9_]+$

Body

application/json
​
reason
string
required

Why you're cancelling. Surfaced to the marketer + audit log.

Required string length: 5 - 500

Response

Cancelled.

​
success
boolean
​
data
object