Skip to content

Team

Remove a member

Removes the membership. The workspace owner cannot be removed, and only owners can remove admins.

DELETE/api/v1/members/{id}
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Path parameters

  • iduuidrequired

    Membership id (id from the members list, not user_id).

    Example
    92a3b4c5-d6e7-4f80-91a2-b3c4d5e6f708

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • okboolean

    Always true.

Status codes

  • 200OK. The member was removed.
  • 400Bad request. The id is not a valid UUID.
  • 401Unauthorized. No signed-in session (unauthorized).
  • 403Forbidden. API keys and non-admins are rejected (see Console only). Rules: the workspace owner cannot be removed, only owners can remove admins, the workspace owner cannot leave this way.
  • 404Not found. No member with this id in the workspace.