> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.brevo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server.

# Invited users management

Manage users in your Brevo profile. This guide helps profile owners manage users, edit invited users' access permissions, and delete users via the API endpoints below.

## Get all invited users

Retrieve your invited users by sending a `GET` request to `https://api.brevo.com/v3/organization/invited/users`. Sample cURL request:

```curl
curl --request GET \
     --url https://api.brevo.com/v3/organization/invited/users \
     --header 'accept: application/json' \
     --header 'api-key: '
```

This `GET` endpoint takes no parameters — your API key alone is enough to retrieve a JSON response listing the users invited to your account. Response codes:

| Response code | Message           | Description                                                                    |
| :------------ | :---------------- | :----------------------------------------------------------------------------- |
| `200`         | List of all users | Returns invited users, their status, the features they use, and other details. |
| `400`         | Bad request       | Returned for `invalid_parameters` or `missing_parameters`.                     |

Sample JSON response with all users and their details, including owners and invited users:

```json
{
  "users": [
    {
      "email": "owner@company.com",
      "is_owner": true,
      "status": "active",
      "feature_access": {
        "marketing": "owner",
        "conversations": "owner",
        "crm": "owner"
      }
    },
    {
      "email": "pendingInvitedUser@company.com",
      "is_owner": false,
      "status": "pending",
      "feature_access": {
        "marketing": "custom",
        "conversations": "none",
        "crm": "full"
      }
    },
    {
      "email": "connectedInvitedUser@company.com",
      "is_owner": false,
      "status": "active",
      "feature_access": {
        "marketing": "none",
        "conversations": "full",
        "crm": "none"
      }
    }
  ]
}
```

## Get users permissions

Send a `GET` request to `https://api.brevo.com/v3/organization/user/{email}/permissions` to retrieve an invited user's permissions. Sample cURL request:

```curl
curl --request GET \
     --url https://api.brevo.com/v3/organization/user/example%40brevo.com/permissions \
     --header 'accept: application/json' \
     --header 'api-key: '
```

The only parameter is `email`:

| Attribute | Datatype | Description                | Value                                         |
| :-------- | :------- | :------------------------- | :-------------------------------------------- |
| `email`   | String   | Email for the invited user | [example@email.com](mailto:example@email.com) |

On success, the response lists the features and permissions for the invited user. Sample `200` response:

```json
{
  "email": "invitedUser@company.com",
  "status": "active",
  "privileges": [
    {
      "feature": "Email campaign",
      "permissions": [
        "Create / edit / delete",
        "Send / schedule / suspend"
      ]
    },
    {
      "feature": "Templates",
      "permissions": [
        "Create / edit / delete",
        "Activate / deactivate"
      ]
    },
    {
      "feature": "SMS campaign",
      "permissions": [
        "Create / edit / delete",
        "Send / schedule / suspend"
      ]
    },
    {
      "feature": "Facebook Ads",
      "permissions": [
        "Schedule / pause"
      ]
    },
    {
      "feature": "Landing pages",
      "permissions": [
        "All"
      ]
    },
    {
      "feature": "Workflows",
      "permissions": [
        "Create / edit / delete",
        "Activate / deactivate / Pause"
      ]
    },
    {
      "feature": "Contacts",
      "permissions": [
        "View",
        "Contact forms"
      ]
    },
    {
      "feature": "SMTP & API",
      "permissions": [
        "SMTP",
        "API Keys",
        "Authorized IPs"
      ]
    },
    {
      "feature": "User management",
      "permissions": [
        "None"
      ]
    },
    {
      "feature": "Sales Platform",
      "permissions": [
        "All"
      ]
    },
    {
      "feature": "Conversations",
      "permissions": [
        "None"
      ]
    },
    {
      "feature": "Senders, Domains & Dedicated IPs",
      "permissions": [
        "Senders management",
        "Domains management",
        "Dedicated IPs management"
      ]
    },
    {
      "feature": "Push",
      "permissions": [
        "View",
        "Create / edit / delete",
        "Send",
        "Settings"
      ]
    },
    {
      "feature": "Companies",
      "permissions": [
        "Create / edit / delete owned companies",
        "Manage companies from other users",
        "Settings"
      ]
    }
  ]
}
```

Sample `400` bad request response:

```json
{
  "code": "method_not_allowed",
  "message": "POST Method is not allowed on this path"
}
```

Response codes:

| Response code | Message     | Description                                                                                                  |
| :------------ | :---------- | :----------------------------------------------------------------------------------------------------------- |
| `200`         | Success     | The JSON response includes the user's email, account status, and privileges.                                 |
| `400`         | Bad request | Incorrect parameters — for example, an invalid email format, or the account does not support inviting users. |

## Resend / Cancel Invitation

Send a `PUT` request to `https://api.brevo.com/v3/organization/user/invitation/{action}/{email}` to resend, cancel, or revoke an invited user's access. The two parameters:

| Attribute | Datatype | Description                                    | Value               |
| :-------- | :------- | :--------------------------------------------- | :------------------ |
| `action`  | String   | The action to be performed on the invited user | `resend`, `cancel`  |
| `email`   | String   | Email of the invited user                      | `example@brevo.com` |

On success, the response shows an `OK` status. Sample `200` response:

```json
{
  "status": "OK",
  "credit_notes": [
    "TEST-123"
  ]
}
```

If you lack permission to change the user's access rights, you receive a `403`. Sample error response:

```json
{
  "message": "string",
  "developer_message": "string"
}
```

Response codes:

| Response codes | Message             | Description                                                   |
| :------------- | :------------------ | :------------------------------------------------------------ |
| `200`          | Success             | The `PUT` request succeeded and access rights were updated.   |
| `403`          | Unauthorized access | You do not have permission to resend or cancel an invitation. |

## Revoke a user's permission

Revoke an invited user's access by sending a `PUT` request to `https://api.brevo.com/v3/organization/user/invitation/revoke/{email}`. Sample cURL request:

```curl
curl --request PUT \
     --url https://api.brevo.com/v3/organization/user/invitation/revoke/revokeduser%40email.com \
     --header 'accept: application/json' \
     --header 'api-key: '
```

The only attribute is `email`:

| Attribute | Datatype | Description                                     | Value                   |
| :-------- | :------- | :---------------------------------------------- | :---------------------- |
| `email`   | String   | Email of the user whose access is to be revoked | `revokeduser@email.com` |

On success, the JSON response includes a `200` or `403` response code:

| Response code | Message             | Description                                           |
| :------------ | :------------------ | :---------------------------------------------------- |
| `200`         | Credit note exists  | User's access to the account was revoked.             |
| `403`         | Unauthorized access | You are not authorized to revoke access for any user. |

Sample JSON response:

```json
{
  "status": "OK",
  "credit_notes": [
    "TEST-123"
  ]
}
```

## Send an invitation to the user

Invite a user by sending a `POST` request to `https://api.brevo.com/v3/organization/user/invitation/send`. The user receives an email to join your account and access selected features. Sample cURL request:

```curl
curl --request POST \
     --url https://api.brevo.com/v3/organization/user/invitation/send \
     --header 'accept: application/json' \
     --header 'api-key: ' \
     --header 'content-type: application/json' \
     --data '
{
  "all_features_access": false,
  "email": "inviteuser@example.com",
  "privileges": [
    {
      "feature": "sms_campaigns",
      "permissions": [
        "view",
        "create_edit_delete"
      ]
    },
    {
      "feature": "transactional_emails",
      "permissions": [
        "activate_deactivate",
        "settings"
      ]
    }
  ]
}
```

See the [API reference](/reference/inviteuser) for full parameter details. The invitation parameters:

| Attribute             | Datatype | Description                                                      | Value                                         |
| :-------------------- | :------- | :--------------------------------------------------------------- | :-------------------------------------------- |
| `email`               | String   | Email of the invited user                                        | [example@brevo.com](mailto:example@brevo.com) |
| `all_features_access` | Boolean  | Describes if all the features can be accessed by the user or not | true or false                                 |
| `privileges`          | Object   | Object showing the features for the user and its permissions     | `feature`, `permissions`                      |

`features` and `permissions` have predefined values to choose from. The `privileges` object attributes:

| Attribute     | Datatype | Description                     | Value                                                                                                 |
| :------------ | :------- | :------------------------------ | :---------------------------------------------------------------------------------------------------- |
| `features`    | String   | The features offered from Brevo | Some of the features are `landing_pages`, `smtp_api`, `sales_platform`, `user_management` and `phone` |
| `permissions` | String   | Permissions for the features    | Some of the permissions are`all` or `send_schedule_suspend` or `create_edit_delete`                   |

Response codes:

| Response code | Message                      | Description                                                                                           |
| :------------ | :--------------------------- | :---------------------------------------------------------------------------------------------------- |
| `200`         | `{ "status": "ok" }`         | Invitation sent successfully.                                                                         |
| `400`         | `invalid_invitation_request` | Invitation request is invalid — for example, an unsupported plan, or the user limit has been reached. |
| `403`         | `access_denied`              | Access denied to invite users.                                                                        |

Sample JSON response:

```json
{
  "status": "OK",
  "credit_notes": [
    "TEST-123"
  ],
  "invoice_id": "string"
}
```

## Update users permissions

Update an invited user's permissions by sending a `POST` request to `https://api.brevo.com/v3/organization/user/update/permissions`. Sample cURL request:

```curl
curl --request POST \
     --url https://api.brevo.com/v3/organization/user/update/permissions \
     --header 'accept: application/json' \
     --header 'api-key: ' \
     --header 'content-type: application/json' \
     --data '
{
  "all_features_access": true,
  "email": "inviteuser@example.com"
}
'
```

See the [API reference](/reference/edit-user-permission) for full parameter details. The parameters mirror those for sending an invitation:

| Attribute             | Datatype | Description                                                      | Value                                         |
| :-------------------- | :------- | :--------------------------------------------------------------- | :-------------------------------------------- |
| `email`               | String   | Email of the invited user                                        | [example@brevo.com](mailto:example@brevo.com) |
| `all_features_access` | Boolean  | Describes if all the features can be accessed by the user or not | true or false                                 |
| `privileges`          | Object   | Object showing the features for the user and its permissions     | `feature`, `permissions`                      |

For the `privileges` object, we will define its attributes below:

| Attribute     | Datatype | Description                     | Value                                                                                                 |
| :------------ | :------- | :------------------------------ | :---------------------------------------------------------------------------------------------------- |
| `features`    | String   | The features offered from Brevo | Some of the features are `landing_pages`, `smtp_api`, `sales_platform`, `user_management` and `phone` |
| `permissions` | String   | Permissions for the features    | `all` or `none`                                                                                       |

Response codes:

| Response code | Message                      | Description                                                                                           |
| :------------ | :--------------------------- | :---------------------------------------------------------------------------------------------------- |
| `200`         | `{ "status": "ok" }`         | Invitation sent successfully.                                                                         |
| `400`         | `invalid_invitation_request` | Invitation request is invalid — for example, an unsupported plan, or the user limit has been reached. |
| `403`         | `access_denied`              | Access denied to invite users.                                                                        |

Sample `200` success response:

```json
{
  "status": "OK",
  "credit_notes": [
    "TEST-123"
  ],
  "invoice_id": "string"
}
```