Where one campaign stands

Scope: campaigns:read.

get/campaigns/{id}

Request

  • Base URL: https://app.distribution.tech/api/v1
  • URL: https://app.distribution.tech/api/v1/campaigns/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

OK

idstring uuid required
campaignstring required
created_atstring date-time required
refunded_atstring date-time nullable required

When the order was refunded; null unless it was.

archived_atstring date-time nullable required

When the brand archived the campaign; null for a live one. An archived campaign's stage reads Archived, and renaming it or setting its creator guidelines is refused (409 conflict, reason archived).

intent_status'draft' | 'ready' | 'null' nullable required
plan_status'awaiting_approval' | 'approved' | 'null' nullable required
open_changeboolean required
stage'Draft' | 'Sent' | 'Plan ready' | 'Approved' | 'Paid' | 'Running' | 'Complete' | 'Cancelled' | 'Archived' required
stage_id'draft' | 'sent' | 'plan_ready' | 'approved' | 'paid' | 'running' | 'complete' | 'cancelled' required

draft (not sent), sent (no plan yet), plan_ready (a plan waits for approval), approved (signed, not paid), paid (the brand's payment cleared, no post started), running (a post is scheduled, live or delayed), complete (every post has its proof), cancelled (the order was cancelled or refunded).

Changes

No recorded changes to this operation across all 1 revision of this API.