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>"
}
'
import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel"

payload = { "reason": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel"

payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "order_id": "<string>"
  }
}
{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}
{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}
{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}
{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}
{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}
{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}
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