Members

Remove a member

DELETE/v1/workspaces/{workspaceId}/members/{userId}

Remove a member. Their access ends at once. The owner can't be removed and answers 409 cannot_remove_owner. A member limited to some brands can't remove anyone and gets 403 brand_access_limited, but they can leave.

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.
userIdstringrequired
The member to remove.

Query parameters

revokeKeysboolean
Also revoke the API keys this person created in this workspace. Otherwise their keys belong to the workspace and keep working. A member limited to some brands always has their keys revoked, because a key reaches what its creator reaches.
default false

Response

200 with a JSON body.

Errors answer with a status and the error shape.