Skip to navigation

Remove Member

View as Markdown

Remove a user from a firm.

Allowed roles:

  • owner

Path params:

  • firm_slug (string)
  • user_id (int)

Response:

  • { "deleted": true }

Errors:

  • 401: Missing/invalid token
  • 403: Forbidden
  • 404: Firm or membership not found
  • 409: Cannot remove firm owner

Authentication

Authorizationstring
API Key authentication via header

Path parameters

user_idintegerRequired
firm_slugstringRequired3-64 characters

Response

Successful Response
datamap from strings to any
statusstringOptionalDefaults to success

Errors

422
Unprocessable Entity Error