COcoderabbit

Seats

Changed on

Bulk assign or unassign seats for up to 500 users. The request format depends on the type of API key used. Organization and self-hosted instance API keys address users by provider user ID with the action + user_ids format, where the action field determines the operation type. Workspace API keys address users by email or CodeRabbit user ID (cr_user_id) with the members format, where each entry declares its desired seat state via seat_assigned. Sending the action + user_ids format with a workspace API key (or the members format with an organization key) fails with an INVALID_REQUEST error.

post/v1/users/seats

Request

  • Base URL
    https://api.coderabbit.ai
  • Auth
    API key in header x-coderabbitai-api-key

Headers

x-coderabbitai-api-keystring required

Your CodeRabbit API key

Request body

OR

Response

Operation completed (check status field for partial failures). The succeeded and failed entries echo the identifiers used in the request: provider user IDs for organization and self-hosted instance keys; for workspace keys, whichever identifier each member supplied (cr_user_id when provided, otherwise email).

status'success' | 'partial_success' | 'failure' required

Operation status: 'success' if all succeeded, 'partial_success' if some succeeded, 'failure' if all failed

succeededstring[] required

Array of user IDs that were successfully processed

Changes

  • 401789d85d01Revision changes
    • breaking

      the request's body type changed from object to no type

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added to the request body oneOf list

    • info

      added the required property // to the response with the status