Creators

Validate custom rates (dry-run)

Validates custom rates for one or more creators on the campaign exactly as the write would, without writing: per creator every value that changes, the existing custom values a merge replaces, warnings about odd values, and for a single creator their unpaid periods priced before and after. Pass the previewHash to the write to make sure it writes what was reviewed.

post/campaigns/{id}/custom-rates/validate

Request

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

Path parameters

idstring required

Campaign ID with orgcamp_ prefix

Example:orgcamp_RwmraAffhMt9

Request body

creatorIdsstring[] required

The creators the values are for (assigning several creators at once: up to 50).

mode'replace' | 'merge'

replace: the values become the creator's whole set (the custom-rates write). merge: they are merged into each creator's existing values (assigning or switching with customRates).

videoTargetinteger nullable

The creator's own video target per cycle, in the campaign's unit (videos or creatives; per-platform campaigns use videoTargetPlatforms). Setting replaces their set (PUT): omitted or null follows the campaign's. Assigning merges: omitted or null keeps what they have, the campaign's own value resets it. A base payout capped at the campaign target is capped at this one instead.

videoTargetPlatformsobject nullable

For a campaign whose video target counts per platform: the creator's own count per platform (only the campaign's platforms; one left out follows the campaign's), with the same replace and merge rules as videoTarget. E.g. {"tiktok": 20}.

Example request

{
  "videoTarget": 15,
  "videoTargetPlatforms": {
    "tiktok": 20
  },
  "values": [
    {
      "id": "rule_A1b2C3d4E5f6",
      "value": 12
    }
  ]
}

Response

OK

okboolean required
previewHashstring
currencystring

Changes

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