Creators

List a campaign's custom rates

Returns every creator with custom rates on the campaign: their own values (major units, each naming a payout of the campaign spec by id), whether they are assigned, and the campaign's own values for reference.

get/campaigns/{id}/custom-rates

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/campaigns/{id}/custom-rates
  • Auth: API key in header x-api-key

Path parameters

idstring required

Campaign ID with orgcamp_ prefix

Example:orgcamp_RwmraAffhMt9

Response

OK

campaignIdstring required

Campaign ID with orgcamp_ prefix

currencystring required
unavailableReasonstring nullable required

Why this campaign cannot have custom rates; null when it can.

Example response

{
  "campaignId": "orgcamp_RwmraAffhMt9",
  "rows": [
    {
      "countNoun": "creative",
      "group": "Base payout · TikTok",
      "label": "Per video",
      "unitLabel": "per video"
    }
  ]
}

Changes

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