Send invitation to an admin user | Brevo API Documentation

This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - my_plan`:

“all”
api:
- “none”
user_management:
- “all”
app_management | Not available in ENTv2:
- “all”
sub_organization_groups
- “create”
- “edit_delete”
create_sub_organizations
- “all”
manage_sub_organizations
- “all”
analytics
- “download_data”
- “create_alerts”
- “my_looks”
- “explore_create”
security
- “all” Note: - If all_features_access: false then only privileges are required otherwise if true then it’s assumed that all permissions will be there for the invited admin user.

`This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - "all" - `api`: - "none" - `user_management`: - "all" - `app_management` | Not available in ENTv2: - "all" - `sub_organization_groups` - "create" - "edit_delete" - `create_sub_organizations` - "all" - `manage_sub_organizations` - "all" - `analytics` - "download_data" - "create_alerts" - "my_looks" - "explore_create" - `security` - "all" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Payload to send an invitation

all_features_accessbooleanRequired

All access to the features

emailstringRequiredformat: "email"

Email address for the organization

privilegeslist of objectsRequired

groupIdslist of stringsOptional

Ids of Group

Response

Invitation ID

idstring or null

1	var client = new RestClient("https://api.brevo.com/v3/corporate/user/invitation/send");
2	var request = new RestRequest(Method.POST);
3	request.AddHeader("api-key", "<apiKey>");
4	request.AddHeader("Content-Type", "application/json");
5	request.AddParameter("application/json", "{\n \"all_features_access\": true,\n \"email\": \"inviteuser@example.com\",\n \"privileges\": [\n {}\n ]\n}", ParameterType.RequestBody);
6	IRestResponse response = client.Execute(request);

1	{
2	"id": "659xxxxxxxxxxxxxxxx6ef9c8"
3	}

Authentication

Request

Response

Errors