Join a campaign
Accepts a participant invite, or joins through an open invite link. With a participant
token the body is ignored and the invite is accepted. With an open invite token a new
participant is created from displayName (required) and email (optional), and a fresh
participant token comes back: keep it, it is the creator's only key to their page.
Open-link joins are limited to about 20 per IP address and 60 per link every 10 minutes.
Path Parameters
A participant token or an open invite token. A malformed token answers 404 like an unknown one.
^[A-Za-z0-9_-]{16,128}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.creatorportal.joinCreatorCampaign({ body: { displayName: 'Example', email: 'user@example.com', },});console.log(data);{ "participantToken": "string"}Read a creator invite or participant page
What a creator sees behind a campaign link, with no API key. `token` is either an open invite token (from `POST /v1/creator-campaigns/{campaignId}/invite-link`), which answers `kind: invite` with the campaign only, or a participant token (from an invite or a join), which answers `kind: participant` with the creator's connected accounts, latest 100 submissions, earnings and payout setup. Reading a participant page also re-checks the creator's connected accounts. Never cached.
Email a creator their campaign links
For a creator who lost their link. Emails every personal participant link held by `email` in one message, optionally only the one for `campaignId`. Removed participants and draft campaigns are left out. Always answers 202 with the same body, so the answer never tells whether the address has links. Limited to 5 requests per hour per email address and 5 per hour per IP address.