Unsubscribe a member

Unsubscribes a member from the community associated with your API key. The member stops receiving messages and is sent an opt-out confirmation message.

Unsubscribing isn’t permanent. The member can opt back in at any time by messaging your community.

The request body is optional. The response is a Member object, the same one returned by GET /members/{member_id}.

Unsubscribing without a confirmation message

To skip the opt-out confirmation message, send:

{ "silent": true }

The member is unsubscribed the same way and can still opt back in.

Which members can be unsubscribed

You can only unsubscribe members who have joined. Unsubscribing a member whose status is new (they haven’t confirmed yet) or blocked returns a member_state_conflict error.

Members on multiple channels

Unsubscribing affects only this member record. If the same person is also a member on another channel, they stay subscribed there. To fully unsubscribe them, unsubscribe each member.

Retries

This endpoint is idempotent. Unsubscribing a member who’s already unsubscribed doesn’t change anything and returns 200 with the member, so retries are safe.

Path Params
uuid
required

The member's identifier.

Body Params

How to unsubscribe the member.

Options for the unsubscribe.

boolean
Defaults to false

When true, the member gets no opt-out confirmation message.

Headers
string

Pins the API version for this request as YYYY-MM-DD. Defaults to the version pinned to your
credential.

Responses

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