Send invitation to user | Brevo API Documentation

Feature - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. Permission - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - email_campaigns:

“create_edit_delete”
“send_schedule_suspend”
sms_campaigns:
- “create_edit_delete”
- “send_schedule_suspend”
contacts:
- “view”
- “create_edit_delete”
- “import”
- “export”
- “list_and_attributes”
- “forms”
templates:
- “create_edit_delete”
- “activate_deactivate”
workflows:
- “create_edit_delete”
- “activate_deactivate_pause”
- “settings”
landing_pages:
- “all”
transactional_emails:
- “settings”
- “logs”
smtp_api:
- “smtp”
- “api_keys”
- “authorized_ips”
user_management:
- “all”
sales_platform:
- “create_edit_deals”
- “delete_deals”
- “manage_others_deals_tasks”
- “reports”
- “settings”
phone:
- “all”
conversations:
- “access”
- “assign”
- “configure”
senders_domains_dedicated_ips:
- “senders_management”
- “domains_management”
- “dedicated_ips_management”
push_notifications:
- “view”
- “create_edit_delete”
- “send”
- “settings”
companies:
- “manage_owned_companies”
- “manage_other_companies”
- “settings” 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 user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.

`Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - "create_edit_delete" - "send_schedule_suspend" - `sms_campaigns`: - "create_edit_delete" - "send_schedule_suspend" - `contacts`: - "view" - "create_edit_delete" - "import" - "export" - "list_and_attributes" - "forms" - `templates`: - "create_edit_delete" - "activate_deactivate" - `workflows`: - "create_edit_delete" - "activate_deactivate_pause" - "settings" - `landing_pages`: - "all" - `transactional_emails`: - "settings" - "logs" - `smtp_api`: - "smtp" - "api_keys" - "authorized_ips" - `user_management`: - "all" - `sales_platform`: - "create_edit_deals" - "delete_deals" - "manage_others_deals_tasks" - "reports" - "settings" - `phone`: - "all" - `conversations`: - "access" - "assign" - "configure" - `senders_domains_dedicated_ips`: - "senders_management" - "domains_management" - "dedicated_ips_management" - `push_notifications`: - "view" - "create_edit_delete" - "send" - "settings" - `companies`: - "manage_owned_companies" - "manage_other_companies" - "settings" **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 user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.

Authentication

api-keystring

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

Request

Values to create an invitation

all_features_accessbooleanRequired

All access to the features

emailstringRequiredformat: "email"

Email address for the organization

privilegeslist of objectsRequired

Response

Success

statusstring

Status of the API operation.

invoice_idstring or null

Invoice id

Errors

“create_edit_delete”
“send_schedule_suspend”
sms_campaigns:
- “create_edit_delete”
- “send_schedule_suspend”
contacts:
- “view”
- “create_edit_delete”
- “import”
- “export”
- “list_and_attributes”
- “forms”
templates:
- “create_edit_delete”
- “activate_deactivate”
workflows:
- “create_edit_delete”
- “activate_deactivate_pause”
- “settings”
landing_pages:
- “all”
transactional_emails:
- “settings”
- “logs”
smtp_api:
- “smtp”
- “api_keys”
- “authorized_ips”
user_management:
- “all”
sales_platform:
- “create_edit_deals”
- “delete_deals”
- “manage_others_deals_tasks”
- “reports”
- “settings”
phone:
- “all”
conversations:
- “access”
- “assign”
- “configure”
senders_domains_dedicated_ips:
- “senders_management”
- “domains_management”
- “dedicated_ips_management”
push_notifications:
- “view”
- “create_edit_delete”
- “send”
- “settings”
companies:
- “manage_owned_companies”
- “manage_other_companies”
- “settings” 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 user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.

1	import requests
2
3	url = "https://api.brevo.com/v3/organization/user/invitation/send"
4
5	payload = {
6	"all_features_access": True,
7	"email": "inviteuser@example.com",
8	"privileges": [{}]
9	}
10	headers = {
11	"api-key": "<apiKey>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())