Read campaigns

Use this to compare commission rows before creating an affilink, or to move a brand campaign between draft and live.

Role

client sees that brand’s campaigns, including drafts. influencer and creator see campaigns that are not drafts and not paused, and only public communities or communities they belong to. Discount codes are not in the response.

Requests

  1. GET /api/v1/affilink/{role}/campaigns, then follow next_cursor.
  2. GET /api/v1/affilink/{role}/campaigns/{id} when you need one campaign.
  3. Client only, empty body: POST /api/v1/affilink/client/campaigns/{id}/launch moves draft to live. POST /api/v1/affilink/client/campaigns/{id}/pause moves live to paused. A default campaign cannot be paused.

Keep

Keep id, status, product_id, is_default, and each commissions row: product_event_name, audience, reward_type, reward_amount, rank, and level. rank of -1 means all ranks. Launch and pause return the campaign.

Stop

Do not launch or pause on the influencer or creator path. Those routes are not there. A not_found means the campaign is missing or not visible to this role. Do not create a campaign. Commission field names are on the AffiLink API page.