Invite

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

Overview

Invite one or more people to a membership-type subscription by email (1–100 per request). Each invitation creates a pending member and, when the site is configured for it, sends an invitation email. The response is the customer resource with a fresh JWT.

Example:

curl --request POST \
  --url 'https://www.pelcro.com/api/v1/sdk/subscriptions/1002/members/invite?site_id=1025' \
  --header 'Authorization: Bearer <JWT>' \
  --header 'Content-Type: application/json' \
  --data '{ "invitation_emails": ["[email protected]"] }'

Notes

  • Protected — requires the customer's JWT.
  • Each email must be valid, not already invited to this subscription, and within the plan's seat capacity — otherwise a 400 validation error is returned.
  • A subscription that is not a membership owned by the customer is rejected with 400.
Path Params
integer
required
Query Params
int32
required
Body Params
invitation_emails
array of strings
required
length between 1 and 100
invitation_emails*
Headers
string
required
Defaults to Bearer <token>
Responses

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