Delete a member

Permanently deletes a member from the community associated with your API key. This can’t be undone.

Deleting a member:

  • Removes the member, their custom data, and their subcommunity memberships
  • Stops all messages to that member

The request takes no body. The response is a DeletedMember object.

Re-adding a deleted member

You can’t re-create a deleted member through the API. A POST /members with the same communication_channel and communication_channel_id returns 409 with member_deleted. The person can still rejoin on their own.

Members on multiple channels

Each channel is a separate member. If someone is reachable on both SMS and WhatsApp, they have two member records, and you need to delete each one.

Retries

This endpoint is idempotent. Repeating the request, or deleting a member that’s already deleted, returns 200 with the same response body, so retries are safe.

Path Params
uuid
required

The member's identifier.

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