Creators · Creator Portal

Join a campaign

Joins a campaign.

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

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, optional

  • displayNamestring

    1 to 200 characters.

  • emailstring (email)

Example

curl -X POST "https://api.pozy.ai/public/creator-campaigns/string" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Acme",
  "email": "alex@example.com"
}'

Response

201 on success

  • participantTokenstringrequired
201 response
{
  "participantToken": "string"
}

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