All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| CorporateGroupIdDelete | Delete /corporate/group/{id} | Delete a group |
| CorporateGroupIdGet | Get /corporate/group/{id} | GET a group details |
| CorporateGroupIdPut | Put /corporate/group/{id} | Update a group of sub-accounts |
| CorporateGroupPost | Post /corporate/group | Create a new group of sub-accounts |
| CorporateGroupUnlinkGroupIdSubAccountsPut | Put /corporate/group/unlink/{groupId}/subAccounts | Delete sub-account from group |
| CorporateMasterAccountGet | Get /corporate/masterAccount | Get the details of requested master account |
| CorporateSsoTokenPost | Post /corporate/ssoToken | Generate SSO token to access admin account |
| CorporateSubAccountGet | Get /corporate/subAccount | Get the list of all the sub-accounts of the master account. |
| CorporateSubAccountIdApplicationsTogglePut | Put /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s) |
| CorporateSubAccountIdDelete | Delete /corporate/subAccount/{id} | Delete a sub-account |
| CorporateSubAccountIdGet | Get /corporate/subAccount/{id} | Get sub-account details |
| CorporateSubAccountIdPlanPut | Put /corporate/subAccount/{id}/plan | Update sub-account plan |
| CorporateSubAccountIpAssociatePost | Post /corporate/subAccount/ip/associate | Associate an IP to sub-accounts |
| CorporateSubAccountIpDissociatePut | Put /corporate/subAccount/ip/dissociate | Dissociate an IP from sub-accounts |
| CorporateSubAccountKeyPost | Post /corporate/subAccount/key | Create an API key for a sub-account |
| CorporateSubAccountPost | Post /corporate/subAccount | Create a new sub-account under a master account. |
| CorporateSubAccountSsoTokenPost | Post /corporate/subAccount/ssoToken | Generate SSO token to access sub-account |
| CorporateUserInvitationActionEmailPut | Put /corporate/user/invitation/{action}/{email} | Resend / cancel admin user invitation |
| CorporateUserRevokeEmailDelete | Delete /corporate/user/revoke/{email} | Revoke an admin user |
| GetAccountActivity | Get /organization/activities | Get user activity logs |
| GetCorporateInvitedUsersList | Get /corporate/invited/users | Get the list of all admin users |
| GetCorporateUserPermission | Get /corporate/user/{email}/permissions | Check admin user permissions |
| GetSubAccountGroups | Get /corporate/groups | Get the list of groups |
| InviteAdminUser | Post /corporate/user/invitation/send | Send invitation to an admin user |
CorporateGroupIdDelete(ctx, id) Delete a group
This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Id of the group |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateGroupDetailsResponse CorporateGroupIdGet(ctx, id) GET a group details
This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Id of the group of sub-organization |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateGroupIdPut(ctx, id, body) Update a group of sub-accounts
This endpoint allows you to update a group of sub-accounts
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Id of the group | |
| body | Body3 | Group details to be updated. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse201 CorporateGroupPost(ctx, body) Create a new group of sub-accounts
This endpoint allows to create a group of sub-accounts
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Body | Group details to be created. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateGroupUnlinkGroupIdSubAccountsPut(ctx, groupId, body) Delete sub-account from group
This endpoint allows you to remove a sub-organization from a group.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Id of the group | |
| body | Body4 | List of sub-account ids |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MasterDetailsResponse CorporateMasterAccountGet(ctx, ) Get the details of requested master account
This endpoint will provide the details of the master account.
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]
GetSsoToken CorporateSsoTokenPost(ctx, ssoTokenRequestCorporate) Generate SSO token to access admin account
This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| ssoTokenRequestCorporate | SsoTokenRequestCorporate | User email of admin account |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SubAccountsResponse CorporateSubAccountGet(ctx, offset, limit) Get the list of all the sub-accounts of the master account.
This endpoint will provide the list all the sub-accounts of the master account.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| offset | int32 | Index of the first sub-account in the page | |
| limit | int32 | Number of sub-accounts to be displayed on each page |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateSubAccountIdApplicationsTogglePut(ctx, id, toggleApplications) Enable/disable sub-account application(s)
API endpoint for the Corporate owner to enable/disable applications on the sub-account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Id of the sub-account organization (mandatory) | |
| toggleApplications | SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateSubAccountIdDelete(ctx, id) Delete a sub-account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Id of the sub-account organization to be deleted |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SubAccountDetailsResponse CorporateSubAccountIdGet(ctx, id) Get sub-account details
This endpoint will provide the details for the specified sub-account company
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Id of the sub-account organization |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateSubAccountIdPlanPut(ctx, id, updatePlanDetails) Update sub-account plan
This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1" to set the consumable in unlimited mode.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | Id of the sub-account organization | |
| updatePlanDetails | SubAccountUpdatePlanRequest | Values to update a sub-account plan |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
interface{} CorporateSubAccountIpAssociatePost(ctx, body) Associate an IP to sub-accounts
This endpoint allows to associate an IP to sub-accounts
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Body1 | Ip address association details |
[*map[string]interface{}**]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateSubAccountIpDissociatePut(ctx, body) Dissociate an IP from sub-accounts
This endpoint allows to dissociate an IP from sub-accounts
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Body2 | Ip address dissociation details |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateApiKeyResponse CorporateSubAccountKeyPost(ctx, createApiKeyRequest) Create an API key for a sub-account
This endpoint will generate an API v3 key for a sub account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createApiKeyRequest | CreateApiKeyRequest | Values to generate API key for sub-account |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateSubAccountResponse CorporateSubAccountPost(ctx, subAccountCreate) Create a new sub-account under a master account.
This endpoint will create a new sub-account under a master account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| subAccountCreate | CreateSubAccount | values to create new sub-account |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSsoToken CorporateSubAccountSsoTokenPost(ctx, ssoTokenRequest) Generate SSO token to access sub-account
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| ssoTokenRequest | SsoTokenRequest | Values to generate SSO token for sub-account |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 CorporateUserInvitationActionEmailPut(ctx, action, email) Resend / cancel admin user invitation
This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| action | string | Action to be performed (cancel / resend) | |
| string | Email address of the recipient |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CorporateUserRevokeEmailDelete(ctx, email) Revoke an admin user
This endpoint allows to revoke/remove an invited member of your Admin account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| string | Email of the invited user |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAccountActivity GetAccountActivity(ctx, optional) Get user activity logs
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetAccountActivityOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetAccountActivityOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| startDate | optional.String | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. | |
| endDate | optional.String | Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | |
| limit | optional.Int64 | Number of documents per page | [default to 10] |
| offset | optional.Int64 | Index of the first document in the page. | [default to 0] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCorporateInvitedUsersList GetCorporateInvitedUsersList(ctx, ) Get the list of all admin users
This endpoint allows you to list all Admin users of your Admin account
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]
GetCorporateUserPermission GetCorporateUserPermission(ctx, email) Check admin user permissions
| 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]
[]InlineResponse2001 GetSubAccountGroups(ctx, ) Get the list of groups
This endpoint allows you to list all groups created on your Admin account.
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]
InviteAdminUser InviteAdminUser(ctx, sendInvitation) Send invitation to an 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\" **Note**: - Ifall_features_access: falsethen only privileges are required otherwise iftrue` then it's assumed that all permissions will be there for the invited admin user.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| sendInvitation | InviteAdminUser | Payload to send an invitation |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]