COPS
Brand API

Create campaign

POST
/campaigns

Create a new campaign in your organization. Only name is required; an optional managerUserId must be a staff member (owner/admin/manager) of the org. Optional links is an ordered list of helpful links ({ title, url }, at most 10, http or https only) shown to creators who join. Returns the created campaign.

Authorization

apiKeyAuth
headerx-api-key<token>

API key for authentication. Keys are prefixed with cops_.

Request Body

application/json
  1. body
name*string
Length1 <= length
url?unknown||null
description?unknown|string|null
logo?unknown||null
color?unknown|string|null
startDate?string
Formatdate-time
platforms?array<>
Default[]
managerUserId?unknown||null
active?boolean
Defaulttrue
links?array<>
Itemsitems <= 10

Response Body

Response schema unavailable.

Example Request
curl -X POST 'https://cops.app/api/brand/campaigns' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response200
Empty

List campaigns GET

List the campaigns in your organization, each with a count of the accounts posting in it. Supports free-text search (q) and a result limit. Use a returned campaign id with get_campaign or as a campaignIds filter elsewhere.

Get campaign by ID GET

Get one campaign in your organization with its full details. Pass an id from list_campaigns.