Skip to main content
Manage your affiliate campaigns programmatically.

​
Endpoints

MethodEndpointDescription
GET/v1/campaignsList all campaigns
GET/v1/campaigns/:idGet a campaign
POST/v1/campaignsCreate a campaign
PATCH/v1/campaigns/:idUpdate a campaign
DELETE/v1/campaigns/:idArchive a campaign

​
List Campaigns

GET /v1/campaigns

​
Query Parameters

ParamTypeDefaultDescription
statusstring-Filter by status: active, paused, archived
limitnumber50Results per page (max 100)
offsetnumber0Pagination offset

​
Response

{
  "campaigns": [
    {
      "id": "cmp_abc123",
      "name": "Summer Sale 2024",
      "status": "active",
      "type": "CPA",
      "commission_type": "percentage",
      "commission_value": 10,
      "target_url": "https://example.com/summer",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 3
  }
}

​
Get Campaign

GET /v1/campaigns/:id

​
Response

{
  "campaign": {
    "id": "cmp_abc123",
    "name": "Summer Sale 2024",
    "slug": "summer-sale-2024-x7k2",
    "target_url": "https://example.com/summer",
    "type": "CPA",
    "status": "active",
    "commission_type": "percentage",
    "commission_value": 10,
    "attribution_window": 30,
    "max_budget": 10000,
    "current_spend": 3180,
    "created_at": "2024-01-15T10:30:00.000Z",
    "stats": {
      "total_affiliates": 45,
      "total_clicks": 12500,
      "total_conversions": 320,
      "total_revenue": 31800.00
    }
  }
}

​
Create Campaign

POST /v1/campaigns
Content-Type: application/json

​
Request Body

FieldTypeRequiredDescription
namestring✅Campaign name
target_urlstring✅Destination URL
typestring✅CPA (conversion-based)
commission_typestring✅fixed or percentage
commission_valuenumber✅Commission amount
visibilitystring-public (default) or private
attribution_windownumber-Days to track conversions (default: 30)
maturation_daysnumber-Days before commission is withdrawable (default: 7)

​
Example

curl -X POST https://api.baclique.com/v1/campaigns \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Black Friday 2024",
    "target_url": "https://example.com/blackfriday",
    "type": "CPA",
    "commission_type": "percentage",
    "commission_value": 15,
    "visibility": "public"
  }'

​
Response

{
  "success": true,
  "campaign": {
    "id": "cmp_xyz789",
    "name": "Black Friday 2024",
    "slug": "black-friday-2024-abc123",
    "target_url": "https://example.com/blackfriday",
    "type": "CPA",
    "status": "active",
    "created_at": "2024-01-20T10:30:00.000Z"
  }
}

​
Update Campaign

PATCH /v1/campaigns/:id
Content-Type: application/json

​
Request Body

All fields are optional. Only include what you want to update. 
{
  "name": "Updated Campaign Name",
  "status": "paused",
  "commission_value": 20,
  "maturation_days": 14
}

​
Example

curl -X PATCH https://api.baclique.com/v1/campaigns/cmp_abc123 \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'

​
Response

{
  "success": true,
  "campaign": {
    "id": "cmp_abc123",
    "name": "Updated Campaign Name",
    "slug": "updated-campaign-name-x7k2",
    "target_url": "https://example.com/updated",
    "type": "CPA",
    "status": "paused",
    "commission_type": "percentage",
    "commission_value": 20,
    "created_at": "2024-01-15T10:30:00.000Z"
  }
}

​
Archive Campaign

Archiving a campaign stops all tracking but preserves historical data. 
DELETE /v1/campaigns/:id

​
Example

curl -X DELETE https://api.baclique.com/v1/campaigns/cmp_abc123 \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

​
Response

{
  "success": true,
  "message": "Campaign archived"
}
💡 Tip: Archived campaigns can be reactivated by updating their status to active.