Invite member

Invite a new customer as a member of a membership subscription.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Send an email invitation to join a group subscription. Creates a pending membership that becomes active when the invited person registers and accepts.

Example: A company administrator invites a new employee by email. The employee receives a personalized invitation to register and claim their membership.


Validation Constraints

FieldConstraint
emailMust be a valid email in RFC 2822 format (max 255 characters)
emailMust not already be invited to this subscription (unique per subscription)
emailMust not belong to an existing active member of this subscription
emailSubject to the subscription's member_seat_capacity limit
subscription_idMust reference a membership-type subscription on the current site
old_provider_idMust be unique per account
Query Params
int32
required
≥ 1

The unique identifier of the site associated with your account.

Body Params
string
required
length ≤ 255

Email address for the invitation. Must be a valid RFC 2822 email. Must not already be invited to this subscription. Subject to the subscription's seat capacity limit.

int32
required

The subscription ID. Must be a membership-type subscription on the current site.

string

Identifier from a previous provider. Must be unique per account.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json