Skip to main content

Deactivate member

POST https://api.rollstack.com/public/v1/members/{userId}/deactivate

Deactivates a member, revokes their API keys and deletes their invites. Send the reason when you know it, so admins see why in the members list.

Requires the users:write scope. Only owners and admins of the organization may call it.

Operation ID: deactivateMember. Only owners and admins can call it.

Path parameters

  • userId (integer, required): The member to act on, by the id from listMembers. An id that is not a member of the organization returns user-not-in-organization.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body

application/json

  • reason (string, required): Why the member is deactivated. other needs reasonDetails. One of left_company, no_longer_needs_access, not_using_enough, too_expensive, switching_tool, duplicate_account, other.
  • reasonDetails (string): Why the member is deactivated, in your words. Required and kept only when reason is other.

Response 204

Success, no content