Creators

Get assignment options

Preflight for POST /creators/campaigns/assign: the cycle-aligned start dates a fixed-anchor campaign offers behind startBasis prev, current and next (null where the assign would refuse the basis; rolling campaigns start on a custom day, today by default), and per creator whether an archived status or a running or scheduled assignment would make the assign fail.

get/creators/campaigns/assign-options

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/creators/campaigns/assign-options
  • Auth: API key in header x-api-key

Query parameters

campaignIdstring required

Campaign ID with orgcamp_ prefix

Example:orgcamp_RwmraAffhMt9
creatorIdsstring[] required

Response

OK

todaystring required

Example response

{
  "campaign": {
    "id": "orgcamp_RwmraAffhMt9",
    "status": "active"
  },
  "creators": [
    {
      "assignment": {
        "campaignId": "orgcamp_RwmraAffhMt9"
      },
      "videosPaidOutsideCampaigns": [
        {
          "platform": "facebook"
        }
      ]
    }
  ]
}

Changes

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