Stop a CPL campaign

curl --request POST \
  --url https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "cplo_abc123"
}
'

import requests

url = "https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop"

payload = { "order_id": "cplo_abc123" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({order_id: 'cplo_abc123'})
};

fetch('https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop', 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://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop",
  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([
    'order_id' => 'cplo_abc123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop"

	payload := strings.NewReader("{\n  \"order_id\": \"cplo_abc123\"\n}")

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

	req.Header.Add("Authorization", "<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://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"cplo_abc123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"cplo_abc123\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "order_id": "cplo_abc123",
    "offer_id": 5,
    "client_offer_id": null,
    "is_client_offer": false,
    "of_account_id": 456789,
    "of_username": "modelname",
    "url": "https://onlyfans.com/modelname/c1",
    "source": "Telegram",
    "quantity_ordered": 100,
    "quantity_delivered": 67,
    "price_per_subscriber": 2.5,
    "total_earned": 167.5,
    "status": "completed",
    "onlyfans_account": {
      "name": "Model Name",
      "username": "modelname",
      "about": "About text",
      "tags": [
        "brunette"
      ],
      "avatar": {
        "original": "https://cdn.example.com/avatar.jpg",
        "thumbnail": "https://cdn.example.com/avatar_thumb.jpg",
        "thumbnail_640": "https://cdn.example.com/avatar_640.jpg"
      },
      "demo_content": [],
      "regular_price": 9.99,
      "promotions": [],
      "blocked_countries": [],
      "subscribers_count": 3400,
      "likes_count": 87000,
      "posts_count": 560,
      "photos_count": 420,
      "videos_count": 140,
      "performer_top": 5
    },
    "auto_renewal": {
      "enabled": true,
      "quantity": 100,
      "max_price": 3,
      "next_price": 2.5,
      "can_renew": false
    },
    "created_at": "2024-01-15T08:00:00+00:00",
    "created_at_ts": 1705305600,
    "changed_at": "2024-06-01T12:00:00+00:00",
    "changed_at_ts": 1717243200,
    "completed_at": "2024-06-01T12:00:00+00:00",
    "completed_at_ts": 1717243200
  }
}

Запись

Остановить CPL-кампанию

Stops the delivery behind an accepted CPL campaign (yours on a client offer, or a client’s on your offer). Same as Stop on the CPL Campaigns page. Returns the campaign row.

Errors (status: "error", HTTP 200):

404 Order not found (unknown id or not your campaign) or Campaign not found (the campaign has no running delivery).
403 Access denied: missing / unknown key, or the account is not an active partner.
429 Rate limit exceeded (30 writes per minute per key, see the Retry-After header).
503 Service is temporarily unavailable: the platform did not answer in time. The action may still have been applied, check the matching read endpoint before repeating it.

POST

api

marketer

cpl

campaigns

stop

Stop a CPL campaign

curl --request POST \
  --url https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "cplo_abc123"
}
'

import requests

url = "https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop"

payload = { "order_id": "cplo_abc123" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({order_id: 'cplo_abc123'})
};

fetch('https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop', 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://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop",
  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([
    'order_id' => 'cplo_abc123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop"

	payload := strings.NewReader("{\n  \"order_id\": \"cplo_abc123\"\n}")

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

	req.Header.Add("Authorization", "<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://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"cplo_abc123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partners.onlytraffic.com/api/marketer/cpl/campaigns/stop")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"cplo_abc123\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "order_id": "cplo_abc123",
    "offer_id": 5,
    "client_offer_id": null,
    "is_client_offer": false,
    "of_account_id": 456789,
    "of_username": "modelname",
    "url": "https://onlyfans.com/modelname/c1",
    "source": "Telegram",
    "quantity_ordered": 100,
    "quantity_delivered": 67,
    "price_per_subscriber": 2.5,
    "total_earned": 167.5,
    "status": "completed",
    "onlyfans_account": {
      "name": "Model Name",
      "username": "modelname",
      "about": "About text",
      "tags": [
        "brunette"
      ],
      "avatar": {
        "original": "https://cdn.example.com/avatar.jpg",
        "thumbnail": "https://cdn.example.com/avatar_thumb.jpg",
        "thumbnail_640": "https://cdn.example.com/avatar_640.jpg"
      },
      "demo_content": [],
      "regular_price": 9.99,
      "promotions": [],
      "blocked_countries": [],
      "subscribers_count": 3400,
      "likes_count": 87000,
      "posts_count": 560,
      "photos_count": 420,
      "videos_count": 140,
      "performer_top": 5
    },
    "auto_renewal": {
      "enabled": true,
      "quantity": 100,
      "max_price": 3,
      "next_price": 2.5,
      "can_renew": false
    },
    "created_at": "2024-01-15T08:00:00+00:00",
    "created_at_ts": 1705305600,
    "changed_at": "2024-06-01T12:00:00+00:00",
    "changed_at_ts": 1717243200,
    "completed_at": "2024-06-01T12:00:00+00:00",
    "completed_at_ts": 1717243200
  }
}

То же, что Stop на странице CPL Campaigns: останавливает доставку по принятой кампании. Работает и для кампаний, размещённых на вашем оффере, и для ваших собственных кампаний на офферах клиентов (запущенных из Find Offers).

Ошибки

Сообщение	Значение
`Order not found`	Неизвестный id, не ваша кампания или числовой внутренний id (`404`)
`Campaign not found`	У кампании нет активной доставки, например она не была принята или уже завершена (`404`)

Авторизации

Authorization

string

header

обязательно

API key from the partner cabinet, Tools -> API (https://partners.onlytraffic.com/tools/api): up to 5 named keys per account, each Full or Read-only, ot_partners_ prefix, shown once at creation. Raw value or Bearer form. Read-only keys cannot call the POST endpoints (403 This API key is read-only); expired or revoked keys get 403 Error! Access denied.

Тело

application/json

order_id

string

обязательно

CPL campaign public id (cplo_…).

Ответ

200 - application/json

Success (check status; errors are also HTTP 200)

Success
Error

status

enum<string>

Доступные опции:

success

message

string

Confirmation text from the platform, when present.

data

object

Show child attributes

Обзор

Платформы

Форматы работы

Выплаты и безопасность

API

Остановить CPL-кампанию

Ошибки

Авторизации

Тело

Ответ

​Ошибки

Авторизации

Тело

Ответ

Ошибки