All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| EditUserPermission | Post /organization/user/update/permissions | Update permission for a user |
| GetInvitedUsersList | Get /organization/invited/users | Get the list of all your users |
| GetUserPermission | Get /organization/user/{email}/permissions | Check user permission |
| Inviteuser | Post /organization/user/invitation/send | Send invitation to user |
| PutRevokeUserPermission | Put /organization/user/invitation/revoke/{email} | Revoke user permission |
| Putresendcancelinvitation | Put /organization/user/invitation/{action}/{email} | Resend / Cancel invitation |
Inviteuser EditUserPermission(ctx, updatePermissions) Update permission for a user
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" - facebook_ads: - "create_edit_delete" - "schedule_pause" - landing_pages: - "all" - transactional_emails: - "settings" - "logs" - smtp_api: - "smtp" - "api_keys" - "authorized_ips" - user_management: - "all" - sales_platform: - "manage_owned_deals_tasks" - "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: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| updatePermissions | Inviteuser | Values to update permissions for an invited user |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetInvitedUsersList GetInvitedUsersList(ctx, ) Get the list of all your users
This endpoint does not need any parameter.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetUserPermission GetUserPermission(ctx, email) Check user permission
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| string | Email of the invited user. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Inviteuser Inviteuser(ctx, sendInvitation) Send invitation to user
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" - facebook_ads: - "create_edit_delete" - "schedule_pause" - landing_pages: - "all" - transactional_emails: - "settings" - "logs" - smtp_api: - "smtp" - "api_keys" - "authorized_ips" - user_management: - "all" - sales_platform: - "manage_owned_deals_tasks" - "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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| sendInvitation | Inviteuser | Values to create an invitation |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PutRevokeUserPermission PutRevokeUserPermission(ctx, email) Revoke user permission
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| string | Email of the invited user. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Putresendcancelinvitation Putresendcancelinvitation(ctx, action, email) Resend / Cancel invitation
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| action | string | action | |
| string | Email of the invited user. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]