Referrals and Invites

Send participant invites

Sends email invites on behalf of a participant to a list of email addresses.

post/campaign/{id}/participant/{participantIdOrEmail}/invites

Request

Base URL
https://api.growsurf.com/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/growsurf/apis/growsurf-rest-api/docs/campaign/:id/participant/:participantIdOrEmail/invites/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

GrowSurf program ID.

participantIdOrEmailstring required

GrowSurf participant ID or URL-encoded participant email address.

emailAddressesstring[] required

messageTextstring required

subjectTextstring required

Invite send result returned.

successboolean required

messageTypestring required

invitesSentinteger required

No recorded changes to this operation across all 7 revisions of this API.