The Only API docs
Campaigns

Create campaign

OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…

POST
/api2/v2/campaigns

OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances, /chats, /purchases, /subscribers/cached, ...) which are Fansly-aware.

Guide: The two surfaces

X-API-Key<token>

Your CRM panel API key

In: header

Header Parameters

user-id*string

Creator account ID of the account to act as (e.g. 509955039). Required — omitting it returns 400 user-id header is required. Use GET /accounts to list your connected accounts. On /api2/v2/* the account must be an OnlyFans account; Fansly accounts are rejected there.

X-Proxy?string

Proxy URL — HTTP or SOCKS5 (e.g. http://user:pass@host:port or socks5://user:pass@host:port). Optional on post-connection routes, where it overrides the proxy saved at login time. Required on the connection routes (POST /accounts/login, POST /accounts/login/cookies, POST /accounts/login/verify-otp) for OnlyFans accounts; optional for Fansly.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api2/v2/campaigns" \  -H "user-id: 509955039" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": 0,  "campaignName": "string",  "campaignCode": "string",  "countTransitions": 0,  "countSubscribers": 0,  "createdAt": "2019-08-24T14:15:22Z",  "sharedWith": [    {      "id": 0,      "name": "string",      "username": "string",      "displayName": "string",      "about": "string",      "avatar": "string",      "avatarThumbs": {        "c50": "string",        "c144": "string"      },      "header": "string",      "email": "string",      "isVerified": true,      "isPerformer": true,      "canEarn": true,      "tipsEnabled": true,      "subscribedBy": true,      "subscribersCount": 0,      "subscribesCount": 0,      "postsCount": 0,      "photosCount": 0,      "videosCount": 0,      "audiosCount": 0,      "friendsCount": 0,      "joinDate": "2019-08-24T14:15:22Z",      "firstPublishedPostDate": "2019-08-24T14:15:22Z",      "subscribePrice": 0,      "chatMessagesCount": 0,      "countPriorityChat": 0,      "countPinnedChat": 0,      "hasPurchasedPosts": true,      "paidFeed": true,      "openseaInfo": {}    }  ]}