Invite / Update Member

post

https://{environment}.community.com/webhooks/{version}/community/{client_id}/subscription_create

Invite a new member to join or update a Member's information. This most commonly used when integrating with an external form, website, or data source.

If the Member does not exist, the Member will be invited.

If the Member already exists, the Member information will be updated.

NOTES:

Both state_or_province and state_or_province_abbreviationmust be provided in order to set a member's state or province.
date_of_birth must be provided as a string in "YYYY-MM-DD" format.
If a member is invited to a Leader's Community using an opt-in mechanism that requires a response (reply-y, signup-link), they have a 30 day window to respond. If they do not respond during this timeframe they will be put into a deleted member subscription state automatically and cannot be resubscribed via subsequent webhook API calls

Body Params

phone_number

string

required

^\d+$

include country code

communication_channel

string

enum

Defaults to sms

only sms and whatsapp are supported at the moment.

Allowed:

given_name

string

length ≤ 255

\S

surname

string

length ≤ 255

\S

string

length ≤ 255

^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$

city

string

length ≤ 255

\S

state_or_province

string

length ≤ 255

\S

state_or_province_abbreviation

string

length between 2 and 3

^[A-Z]+$

country

string

length ≤ 255

\S

country_code

string

^[A-Z]{2}$

postal_code

string

length ≤ 10

^[0-9A-Z]+[ -]?[0-9A-Z]+$

geolocation

object

Defaults to [object Object]

date_of_birth

string

^\d{4}-\d{2}-\d{2}$

Must be supplied in "YYYY-MM-DD" format.

gender_identity

string

enum

Allowed: