Skip to main content
POST
Manage custom role users

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Body

application/json
organization_id
string
required

The ID of the organization that the custom role belongs to.

user_id
string
required

Your user id -- you must be an organization admin to manage custom role users.

group_id
string
required

The ID of the custom role to manage users for.

action
enum<string>
required

The action to perform - either 'add' or 'remove' a user.

Available options:
add,
remove
user_email
string
required

The email address of the target user to add or remove.

Response

User successfully added to or removed from the custom role

success
boolean
message
string

A success message describing the action performed.