Skip to content
/
Update campaign

Update campaign

Request

Update a campaign's status, budget and/or content types. Setting status to paused or active pauses/resumes the campaign and cascades the same status to all its backing subscriptions; resuming runs a credit check. Editing content types re-derives and propagates the detection filters to the campaign's backing subscriptions. Archived or completed campaigns cannot be edited. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits.

Security
Bearer
Path
campaign_idintegerrequired

Unique identifier for the resource

Body
required
statusstring

Set to 'paused' or 'active'. Not allowed on draft campaigns, which activate automatically on the start date.

Enum:"active""paused"
content_typesArray of strings

Replaces the post types counted as campaign content.

tracking_keywordsArray of strings

Replaces the campaign's tracking keywords. Pass an empty list to clear them.

budgetstring or null, (decimal)^-?\d{0,10}(?:\.\d{0,2})?$

Optional campaign budget.

curl -i -X PATCH \
  'https://api-dashboard.influencers.club/public/v1/social/listening/campaign/{campaign_id}/' \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "content_types": [
      "string"
    ],
    "tracking_keywords": [
      "string"
    ],
    "budget": "string"
  }'

Responses

Bodyapplication/json
idintegerrequired
namestringrequired
platformsobjectrequired
statusstringrequired
briefstring
content_typesobject or null
tracking_keywordsobject or null
start_datestring, (date)required
end_datestring, (date)required
budgetstring or null, (decimal)
creator_countstring

Number of live creator links across the campaign's subscriptions.

created_atstring, (date-time)required
updated_atstring, (date-time)required
Response
{
  "id": 0,
  "name": "string",
  "platforms": {
    "property1": null,
    "property2": null
  },
  "status": "string",
  "brief": "string",
  "content_types": {
    "property1": null,
    "property2": null
  },
  "tracking_keywords": {
    "property1": null,
    "property2": null
  },
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "budget": "string",
  "creator_count": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}