Add a contact to a group

Adds the contact identified by phoneNumber to the group identified by groupId. The request body chooses the enrollment mode:

  • optInMode: "DIRECT" (default) — caller asserts prior consent. The contact is added as an active member immediately.
  • optInMode: "CONFIRM" — the system sends an SMS confirmation to the contact. They land in pendingGroups[] until they reply YES.

Consent gate (cannot be overridden): HARD-opted-out contacts are rejected with 409 ContactHardOptedOut (33035). Contacts with PENDING memberships in groups other than the target are rejected with 409 ContactPending (33036).

Idempotency: if the contact is already active or pending in this group, the call is a no-op and returns the current contact state.

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

Contact phone number in E.164 format (+ then country code and subscriber number).

string
required

Group public ID (grp_...).

Body Params
string
enum
Defaults to DIRECT

How the contact should be enrolled. DIRECT adds the contact immediately and asserts prior consent. CONFIRM sends an SMS confirmation and parks the contact in pendingGroups[] until they reply YES.

Allowed:
Responses

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