Remove a member

DELETE

/members/{userId}

const url = 'https://example.com/members/example';
const options = {
  method: 'DELETE',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/members/example \
  --cookie bottle.session_token=<bottle.session_token>

Their account and their history stay; only access to this tenant goes. Admins may not remove an owner, and the last owner cannot be removed.

Authorizations

sessionCookie
members:write
apiKey
members:write

Parameters

Path Parameters

userId

required

string

>= 1 characters

Responses

204

Removed

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or the role is not allowed to do this

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Not a member

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Would leave the tenant without an owner

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}