Start a CPL campaign on a client offer

curl --request POST \
  --url https://partners.onlytraffic.com/api/marketer/cpl/campaigns/start \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offer_id": 512,
  "collaboration": "per_subscription",
  "source": "telegram",
  "campaign_type": "link",
  "speed": 20
}
'

import requests

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

payload = {
    "offer_id": 512,
    "collaboration": "per_subscription",
    "source": "telegram",
    "campaign_type": "link",
    "speed": 20
}
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({
    offer_id: 512,
    collaboration: 'per_subscription',
    source: 'telegram',
    campaign_type: 'link',
    speed: 20
  })
};

fetch('https://partners.onlytraffic.com/api/marketer/cpl/campaigns/start', 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/start",
  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([
    'offer_id' => 512,
    'collaboration' => 'per_subscription',
    'source' => 'telegram',
    'campaign_type' => 'link',
    'speed' => 20
  ]),
  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/start"

	payload := strings.NewReader("{\n  \"offer_id\": 512,\n  \"collaboration\": \"per_subscription\",\n  \"source\": \"telegram\",\n  \"campaign_type\": \"link\",\n  \"speed\": 20\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/start")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offer_id\": 512,\n  \"collaboration\": \"per_subscription\",\n  \"source\": \"telegram\",\n  \"campaign_type\": \"link\",\n  \"speed\": 20\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"offer_id\": 512,\n  \"collaboration\": \"per_subscription\",\n  \"source\": \"telegram\",\n  \"campaign_type\": \"link\",\n  \"speed\": 20\n}"

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

{
  "status": "success",
  "data": {
    "order_id": "cplo_abc123",
    "offer_id": 0,
    "client_offer_id": 512,
    "is_client_offer": true,
    "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": "accepted",
    "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": null,
    "completed_at_ts": null
  }
}

Write

Start CPL Campaign

Find Offers Start: you start delivering traffic to a client’s CPL offer. Same fields, limits and messages as the Start modal on the Find Offers page. Runs one campaign start at a time per account.

Returns the created order as one /api/marketer/cpl/orders row (is_client_offer = true).

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

422 Please fill in all campaign fields when a field is missing or out of range.
422 Limit messages, the same as the cabinet: you already run a campaign on this offer, your order on this model is pending the client’s trial review, or all your CPL campaign slots are taken.
429 Another campaign start is still running. Wait a few seconds and try again (one campaign start at a time per account).
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

start

Start a CPL campaign on a client offer

curl --request POST \
  --url https://partners.onlytraffic.com/api/marketer/cpl/campaigns/start \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offer_id": 512,
  "collaboration": "per_subscription",
  "source": "telegram",
  "campaign_type": "link",
  "speed": 20
}
'

import requests

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

payload = {
    "offer_id": 512,
    "collaboration": "per_subscription",
    "source": "telegram",
    "campaign_type": "link",
    "speed": 20
}
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({
    offer_id: 512,
    collaboration: 'per_subscription',
    source: 'telegram',
    campaign_type: 'link',
    speed: 20
  })
};

fetch('https://partners.onlytraffic.com/api/marketer/cpl/campaigns/start', 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/start",
  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([
    'offer_id' => 512,
    'collaboration' => 'per_subscription',
    'source' => 'telegram',
    'campaign_type' => 'link',
    'speed' => 20
  ]),
  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/start"

	payload := strings.NewReader("{\n  \"offer_id\": 512,\n  \"collaboration\": \"per_subscription\",\n  \"source\": \"telegram\",\n  \"campaign_type\": \"link\",\n  \"speed\": 20\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/start")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offer_id\": 512,\n  \"collaboration\": \"per_subscription\",\n  \"source\": \"telegram\",\n  \"campaign_type\": \"link\",\n  \"speed\": 20\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"offer_id\": 512,\n  \"collaboration\": \"per_subscription\",\n  \"source\": \"telegram\",\n  \"campaign_type\": \"link\",\n  \"speed\": 20\n}"

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

{
  "status": "success",
  "data": {
    "order_id": "cplo_abc123",
    "offer_id": 0,
    "client_offer_id": 512,
    "is_client_offer": true,
    "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": "accepted",
    "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": null,
    "completed_at_ts": null
  }
}

Same as Start on the Find Offers page: you start delivering traffic to a client’s CPL offer. The created order comes back as a /api/marketer/cpl/orders row with is_client_offer true and client_offer_id set.

Fields

Field	Description
`offer_id`	Client offer id from Find Offers (the `client_offer_id` on orders)
`collaboration`	Payout format: `per_subscription`, `per_messages`, `per_first_purchase` or `per_paid_subscription`. The offer must pay for it and not block it for you
`source`	Traffic source slug, the same values the Start form offers (e.g. `telegram`, `instagram`, `tiktok`, `reddit`, `x`)
`campaign_type`	`link` (default) or `free_trial`
`speed`	Subscribers per day you plan to deliver, at least 1

Errors

Message	Meaning
`Please fill in all campaign fields`	A field is missing, `collaboration` / `campaign_type` is not one of the allowed values, or `speed` is below 1 (`422`)
`You already run a campaign on this offer. …`	Per-offer limit (`422`)
`Your order on this model is pending the client's trial review. …`	Wait for the trial result (`422`)
`… of your CPL campaign slots are taken …`	Total campaign limit reached (`422`)
`Another campaign start is still running. Wait a few seconds and try again`	One start at a time per account (`429`), retry after a few seconds

Authorizations

Authorization

string

header

required

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.

Body

application/json

offer_id

integer

required

Client offer id from Find Offers (client_offer_id on orders).

collaboration

enum<string>

required

Payout format you deliver on. Must be one the offer pays for and does not block for you.

Available options:

per_subscription,

per_messages,

per_first_purchase,

per_paid_subscription

source

string

required

Traffic source slug, the same values the Start form offers (for example telegram, instagram, tiktok, reddit, x).

campaign_type

enum<string>

default:link

required

link = campaign link, free_trial = free trial link.

Available options:

link,

free_trial

speed

integer

required

Subscribers per day you plan to deliver.

Required range: x >= 1

Response

200 - application/json

Success (check status; errors are also HTTP 200)

Success
Error

status

enum<string>

Available options:

success

message

string

Confirmation text from the platform, when present.

data

object

Show child attributes

Overview

Platforms

Work Formats

Payments & Safety

API

Start CPL Campaign

Fields

Errors

Authorizations

Body

Response

​Fields

​Errors

Authorizations

Body

Response

Fields

Errors