UserApi

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

editUserPermission

Inviteuser editUserPermission(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_companies" - "manage_others_deals_tasks_companies" - "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" 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.

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

UserApi apiInstance = new UserApi();
Inviteuser updatePermissions = new Inviteuser(); // Inviteuser | Values to update permissions for an invited user
try {
    Inviteuser result = apiInstance.editUserPermission(updatePermissions);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#editUserPermission");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
updatePermissions	Inviteuser	Values to update permissions for an invited user

Return type

Inviteuser

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

getInvitedUsersList

GetInvitedUsersList getInvitedUsersList()

Get the list of all your users

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

UserApi apiInstance = new UserApi();
try {
    GetInvitedUsersList result = apiInstance.getInvitedUsersList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getInvitedUsersList");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

GetInvitedUsersList

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

getUserPermission

GetUserPermission getUserPermission(email)

Check user permission

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

UserApi apiInstance = new UserApi();
String email = "email_example"; // String | Email of the invited user.
try {
    GetUserPermission result = apiInstance.getUserPermission(email);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getUserPermission");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
email	String	Email of the invited user.

Return type

GetUserPermission

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

inviteuser

Inviteuser inviteuser(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_companies" - "manage_others_deals_tasks_companies" - "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" 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.

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

UserApi apiInstance = new UserApi();
Inviteuser sendInvitation = new Inviteuser(); // Inviteuser | Values to create an invitation
try {
    Inviteuser result = apiInstance.inviteuser(sendInvitation);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#inviteuser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
sendInvitation	Inviteuser	Values to create an invitation

Return type

Inviteuser

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

putRevokeUserPermission

PutRevokeUserPermission putRevokeUserPermission(email)

Revoke user permission

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

UserApi apiInstance = new UserApi();
String email = "email_example"; // String | Email of the invited user.
try {
    PutRevokeUserPermission result = apiInstance.putRevokeUserPermission(email);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#putRevokeUserPermission");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
email	String	Email of the invited user.

Return type

PutRevokeUserPermission

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

putresendcancelinvitation

Putresendcancelinvitation putresendcancelinvitation(action, email)

Resend / Cancel invitation

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

UserApi apiInstance = new UserApi();
String action = "action_example"; // String | action
String email = "email_example"; // String | Email of the invited user.
try {
    Putresendcancelinvitation result = apiInstance.putresendcancelinvitation(action, email);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#putresendcancelinvitation");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
action	String	action	[enum: resend, cancel]
email	String	Email of the invited user.

Return type

Putresendcancelinvitation

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

UserApi

editUserPermission

Example

Parameters

Return type

Authorization

HTTP request headers

getInvitedUsersList

Example

Parameters

Return type

Authorization

HTTP request headers

getUserPermission

Example

Parameters

Return type

Authorization

HTTP request headers

inviteuser

Example

Parameters

Return type

Authorization

HTTP request headers

putRevokeUserPermission

Example

Parameters

Return type

Authorization

HTTP request headers

putresendcancelinvitation

Example

Parameters

Return type

Authorization

HTTP request headers