Campaigns
Advertising campaigns within a network
List campaigns in a network
Returns a cursor-paginated page of the network's campaigns ordered by id; use the returned cursor to fetch the next page. Pass ?expand=advertiser to inline each campaign's advertiser. Requires the read_only network role.
Create a campaign in a network
Creates a campaign owned by the network and returns it with a Location header. Only name is required; advertiser_id, when supplied, must reference an existing advertiser (otherwise 400). budget and cpm are in US dollars. platform (adbridge/adswizz/megaphone, defaults to adbridge), an adswizz link, and targeting/tracking may be set. The new campaign starts in the platform-owned pending status; status cannot be set here. Requires the administrator network role.
Get a campaign by id
Returns a single campaign in the network, or 404 if it does not exist. Pass ?expand=advertiser to inline the campaign's advertiser (resolved from advertiser_id). Requires the read_only network role.
Delete a campaign
Permanently deletes the campaign document and responds 204. This is a hard delete of the campaign record only — it does not cascade to the campaign's offers or other nested resources. The delete is optimistic-locked, so a concurrent modification returns 409, and a campaign id that does not exist returns 404. Requires the administrator network role.
Update a campaign's mutable business fields
Partial update: only the fields you send are changed. advertiser_id, when supplied, must reference an existing advertiser; budget and cpm are in US dollars. platform, an adswizz link, and targeting/tracking may be updated. status is read-only and cannot be changed here (use archive). The write is optimistic-locked, so a concurrent modification returns 409. Requires the administrator network role.
Archive a campaign
Transitions the campaign to the archived status and returns it. This is the only client-driven status transition; the rest of the lifecycle (pending, active, completed, cancelled) is platform-owned. Archiving an already-archived campaign returns 409, as does a concurrent modification. Requires the administrator network role.