Documentation / Campaign management / Campaign creators

Payment adjustments and scoring

Set or clear a pending manual bonus, waive a recurring cycle, and control score calculation.

payment adjustments and scoring · json
{ "amount": 75, "currency": "USD" }
All documentation

Pending manual bonus

PUT /sdk/v1/campaign-creators/:campaignCreatorRecordId/pending-bonus requires payouts:write.

{ "amount": 75, "currency": "USD" }

amount must be nonnegative. currency is optional; when present it is a three-letter uppercase currency code. Send { "amount": 0 } to clear the pending bonus. This changes the pending bonus using the platform's currency and contract rules; it does not send money or reverse a paid payout.

Waive a recurring cycle

POST /sdk/v1/campaign-creators/:campaignCreatorRecordId/pay-cycle-windows/waive requires payouts:write.

{ "cycleStartAt": "2026-09-01T00:00:00Z", "reason": "Agreed unpaid warm-up cycle" }

Use the exact payPeriodStart instant from the creator's payout line items. Date-only strings are refused, since a campaign timezone or hourly cadence can place the boundary elsewhere. A reason is required (1–2000 characters).

Only a due recurring window can be waived. The currently running cycle cannot be waived. A cycle in a pending or approving payout returns 409 with APPROVAL_PENDING. A successful response includes the waiver's ID, period boundaries, amount, currency, reason, and actor.

Restore a waived cycle

POST /sdk/v1/campaign-creators/:campaignCreatorRecordId/pay-cycle-windows/restore accepts the same body and scope. It revokes the live waiver and recalculates pending totals. A missing waiver returns 404.

Control score calculation

PATCH /sdk/v1/campaign-creators/:campaignCreatorRecordId/scoring requires campaigns:write.

{ "enabled": false }

Send true to re-enable score calculation. The equivalent campaign-wide endpoint is PATCH /sdk/v1/campaigns/:campaignId/scoring. These controls govern score calculation; use payment exclusions for payment eligibility.

All writes on this page derive agency ownership from the API key and reject completed campaigns with 409.

Describe your program.

Grade turns it into a program it can track and pay.