Creators · Creator Portal

Start payout onboarding

Starts a payout onboarding.

POSThttps://api.pozy.ai/public/creator-campaigns/{token}/payouts
Public, no API keystartCreatorPayouts

Guide: Run a campaign

Request

This endpoint is public. Call it without an API key.

Path parameters

NameTypeNotes
tokenrequiredstringMatches ^[A-Za-z0-9_-]{16,128}$

Request body

application/json, required

  • actionstringrequired

    One of onboard.

  • countrystring

    Matches ^[A-Za-z]{2}$.

Example

curl -X POST "https://api.pozy.ai/public/creator-campaigns/string/payouts" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "onboard"
}'

Response

200 on success

  • urlstring (URL)required
200 response
{
  "url": "https://pozy.ai/media/example-1.jpg"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Creator Portal