brevo_csharp.Api.MasterAccountApi

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
CorporateIpGet	GET /corporate/ip	List of all IPs
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
CorporateSubAccountsPlanPut	PUT /corporate/subAccounts/plan	Update sub-accounts plan
CorporateUserEmailPermissionsPut	PUT /corporate/user/{email}/permissions	Change admin user permissions
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

void CorporateGroupIdDelete (string 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateGroupIdDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = id_example;  // string | Id of the group

            try
            {
                // Delete a group
                apiInstance.CorporateGroupIdDelete(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateGroupIdDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	Id of the group

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateGroupIdGet

CorporateGroupDetailsResponse CorporateGroupIdGet (string 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateGroupIdGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = id_example;  // string | Id of the group of sub-organization

            try
            {
                // GET a group details
                CorporateGroupDetailsResponse result = apiInstance.CorporateGroupIdGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateGroupIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	Id of the group of sub-organization

Return type

CorporateGroupDetailsResponse

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateGroupIdPut

void CorporateGroupIdPut (string id, Body3 body)

Update a group of sub-accounts

This endpoint allows you to update a group of sub-accounts

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateGroupIdPutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = id_example;  // string | Id of the group
            var body = new Body3(); // Body3 | Group details to be updated.

            try
            {
                // Update a group of sub-accounts
                apiInstance.CorporateGroupIdPut(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateGroupIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	Id of the group
body	Body3	Group details to be updated.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateGroupPost

InlineResponse201 CorporateGroupPost (Body body)

Create a new group of sub-accounts

This endpoint allows to create a group of sub-accounts

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateGroupPostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var body = new Body(); // Body | Group details to be created.

            try
            {
                // Create a new group of sub-accounts
                InlineResponse201 result = apiInstance.CorporateGroupPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateGroupPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	Body	Group details to be created.

Return type

InlineResponse201

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateGroupUnlinkGroupIdSubAccountsPut

void CorporateGroupUnlinkGroupIdSubAccountsPut (string groupId, Body4 body)

Delete sub-account from group

This endpoint allows you to remove a sub-organization from a group.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateGroupUnlinkGroupIdSubAccountsPutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var groupId = groupId_example;  // string | Id of the group
            var body = new Body4(); // Body4 | List of sub-account ids

            try
            {
                // Delete sub-account from group
                apiInstance.CorporateGroupUnlinkGroupIdSubAccountsPut(groupId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateGroupUnlinkGroupIdSubAccountsPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
groupId	string	Id of the group
body	Body4	List of sub-account ids

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateIpGet

void CorporateIpGet ()

List of all IPs

This endpoint allows you to retrieve the list of active IPs on your Admin account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateIpGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();

            try
            {
                // List of all IPs
                apiInstance.CorporateIpGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateIpGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateMasterAccountGet

MasterDetailsResponse CorporateMasterAccountGet ()

Get the details of requested master account

This endpoint will provide the details of the master account.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateMasterAccountGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();

            try
            {
                // Get the details of requested master account
                MasterDetailsResponse result = apiInstance.CorporateMasterAccountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateMasterAccountGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

MasterDetailsResponse

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSsoTokenPost

GetSsoToken CorporateSsoTokenPost (SsoTokenRequestCorporate 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSsoTokenPostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var ssoTokenRequestCorporate = new SsoTokenRequestCorporate(); // SsoTokenRequestCorporate | User email of admin account

            try
            {
                // Generate SSO token to access admin account
                GetSsoToken result = apiInstance.CorporateSsoTokenPost(ssoTokenRequestCorporate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSsoTokenPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ssoTokenRequestCorporate	SsoTokenRequestCorporate	User email of admin account

Return type

GetSsoToken

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountGet

SubAccountsResponse CorporateSubAccountGet (int? offset, int? 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var offset = 56;  // int? | Index of the first sub-account in the page
            var limit = 56;  // int? | Number of sub-accounts to be displayed on each page

            try
            {
                // Get the list of all the sub-accounts of the master account.
                SubAccountsResponse result = apiInstance.CorporateSubAccountGet(offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
offset	int?	Index of the first sub-account in the page
limit	int?	Number of sub-accounts to be displayed on each page

Return type

SubAccountsResponse

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountIdApplicationsTogglePut

void CorporateSubAccountIdApplicationsTogglePut (long? id, SubAccountAppsToggleRequest toggleApplications)

Enable/disable sub-account application(s)

API endpoint for the Corporate owner to enable/disable applications on the sub-account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountIdApplicationsTogglePutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = 789;  // long? | Id of the sub-account organization (mandatory)
            var toggleApplications = new SubAccountAppsToggleRequest(); // SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account

            try
            {
                // Enable/disable sub-account application(s)
                apiInstance.CorporateSubAccountIdApplicationsTogglePut(id, toggleApplications);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountIdApplicationsTogglePut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	Id of the sub-account organization (mandatory)
toggleApplications	SubAccountAppsToggleRequest	List of applications to activate or deactivate on a sub-account

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountIdDelete

void CorporateSubAccountIdDelete (long? id)

Delete a sub-account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountIdDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = 789;  // long? | Id of the sub-account organization to be deleted

            try
            {
                // Delete a sub-account
                apiInstance.CorporateSubAccountIdDelete(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountIdDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	Id of the sub-account organization to be deleted

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountIdGet

SubAccountDetailsResponse CorporateSubAccountIdGet (long? id)

Get sub-account details

This endpoint will provide the details for the specified sub-account company

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountIdGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = 789;  // long? | Id of the sub-account organization

            try
            {
                // Get sub-account details
                SubAccountDetailsResponse result = apiInstance.CorporateSubAccountIdGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	Id of the sub-account organization

Return type

SubAccountDetailsResponse

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountIdPlanPut

void CorporateSubAccountIdPlanPut (long? id, SubAccountUpdatePlanRequest 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountIdPlanPutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var id = 789;  // long? | Id of the sub-account organization
            var updatePlanDetails = new SubAccountUpdatePlanRequest(); // SubAccountUpdatePlanRequest | Values to update a sub-account plan

            try
            {
                // Update sub-account plan
                apiInstance.CorporateSubAccountIdPlanPut(id, updatePlanDetails);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountIdPlanPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?	Id of the sub-account organization
updatePlanDetails	SubAccountUpdatePlanRequest	Values to update a sub-account plan

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountIpAssociatePost

Object CorporateSubAccountIpAssociatePost (Body1 body)

Associate an IP to sub-accounts

This endpoint allows to associate an IP to sub-accounts

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountIpAssociatePostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var body = new Body1(); // Body1 | Ip address association details

            try
            {
                // Associate an IP to sub-accounts
                Object result = apiInstance.CorporateSubAccountIpAssociatePost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountIpAssociatePost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	Body1	Ip address association details

Return type

Object

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountIpDissociatePut

void CorporateSubAccountIpDissociatePut (Body2 body)

Dissociate an IP from sub-accounts

This endpoint allows to dissociate an IP from sub-accounts

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountIpDissociatePutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var body = new Body2(); // Body2 | Ip address dissociation details

            try
            {
                // Dissociate an IP from sub-accounts
                apiInstance.CorporateSubAccountIpDissociatePut(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountIpDissociatePut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	Body2	Ip address dissociation details

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountKeyPost

CreateApiKeyResponse CorporateSubAccountKeyPost (CreateApiKeyRequest createApiKeyRequest)

Create an API key for a sub-account

This endpoint will generate an API v3 key for a sub account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountKeyPostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var createApiKeyRequest = new CreateApiKeyRequest(); // CreateApiKeyRequest | Values to generate API key for sub-account

            try
            {
                // Create an API key for a sub-account
                CreateApiKeyResponse result = apiInstance.CorporateSubAccountKeyPost(createApiKeyRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountKeyPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createApiKeyRequest	CreateApiKeyRequest	Values to generate API key for sub-account

Return type

CreateApiKeyResponse

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountPost

CreateSubAccountResponse CorporateSubAccountPost (CreateSubAccount subAccountCreate)

Create a new sub-account under a master account.

This endpoint will create a new sub-account under a master account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountPostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var subAccountCreate = new CreateSubAccount(); // CreateSubAccount | values to create new sub-account

            try
            {
                // Create a new sub-account under a master account.
                CreateSubAccountResponse result = apiInstance.CorporateSubAccountPost(subAccountCreate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
subAccountCreate	CreateSubAccount	values to create new sub-account

Return type

CreateSubAccountResponse

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountSsoTokenPost

GetSsoToken CorporateSubAccountSsoTokenPost (SsoTokenRequest 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountSsoTokenPostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var ssoTokenRequest = new SsoTokenRequest(); // SsoTokenRequest | Values to generate SSO token for sub-account

            try
            {
                // Generate SSO token to access sub-account
                GetSsoToken result = apiInstance.CorporateSubAccountSsoTokenPost(ssoTokenRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountSsoTokenPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ssoTokenRequest	SsoTokenRequest	Values to generate SSO token for sub-account

Return type

GetSsoToken

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateSubAccountsPlanPut

void CorporateSubAccountsPlanPut (SubAccountsUpdatePlanRequest updatePlanDetails)

Update sub-accounts plan

This endpoint will update multiple sub-accounts 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateSubAccountsPlanPutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var updatePlanDetails = new SubAccountsUpdatePlanRequest(); // SubAccountsUpdatePlanRequest | Values to update sub-accounts plan

            try
            {
                // Update sub-accounts plan
                apiInstance.CorporateSubAccountsPlanPut(updatePlanDetails);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateSubAccountsPlanPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
updatePlanDetails	SubAccountsUpdatePlanRequest	Values to update sub-accounts plan

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateUserEmailPermissionsPut

void CorporateUserEmailPermissionsPut (string email, Body5 body)

Change admin user permissions

This endpoint will allow you to change the permissions of Admin users of your Admin account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateUserEmailPermissionsPutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var email = email_example;  // string | Email address of Admin user
            var body = new Body5(); // Body5 | Values to update an admin user permissions

            try
            {
                // Change admin user permissions
                apiInstance.CorporateUserEmailPermissionsPut(email, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateUserEmailPermissionsPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
email	string	Email address of Admin user
body	Body5	Values to update an admin user permissions

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateUserInvitationActionEmailPut

InlineResponse200 CorporateUserInvitationActionEmailPut (string action, string email)

Resend / cancel admin user invitation

This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateUserInvitationActionEmailPutExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var action = action_example;  // string | Action to be performed (cancel / resend)
            var email = email_example;  // string | Email address of the recipient

            try
            {
                // Resend / cancel admin user invitation
                InlineResponse200 result = apiInstance.CorporateUserInvitationActionEmailPut(action, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateUserInvitationActionEmailPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
action	string	Action to be performed (cancel / resend)
email	string	Email address of the recipient

Return type

InlineResponse200

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CorporateUserRevokeEmailDelete

void CorporateUserRevokeEmailDelete (string email)

Revoke an admin user

This endpoint allows to revoke/remove an invited member of your Admin account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class CorporateUserRevokeEmailDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var email = email_example;  // string | Email of the invited user

            try
            {
                // Revoke an admin user
                apiInstance.CorporateUserRevokeEmailDelete(email);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.CorporateUserRevokeEmailDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
email	string	Email of the invited user

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAccountActivity

GetAccountActivity GetAccountActivity (string startDate = null, string endDate = null, string email = null, long? limit = null, long? offset = null)

Get user activity logs

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class GetAccountActivityExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var startDate = startDate_example;  // 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. (optional) 
            var endDate = endDate_example;  // 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. (optional) 
            var email = email_example;  // string | Enter the user's email address to filter their activity in the account. (optional) 
            var limit = 789;  // long? | Number of documents per page (optional)  (default to 10)
            var offset = 789;  // long? | Index of the first document in the page. (optional)  (default to 0)

            try
            {
                // Get user activity logs
                GetAccountActivity result = apiInstance.GetAccountActivity(startDate, endDate, email, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.GetAccountActivity: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
startDate	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.	[optional]
endDate	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.	[optional]
email	string	Enter the user's email address to filter their activity in the account.	[optional]
limit	long?	Number of documents per page	[optional] [default to 10]
offset	long?	Index of the first document in the page.	[optional] [default to 0]

Return type

GetAccountActivity

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCorporateInvitedUsersList

GetCorporateInvitedUsersList GetCorporateInvitedUsersList ()

Get the list of all admin users

This endpoint allows you to list all Admin users of your Admin account

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class GetCorporateInvitedUsersListExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();

            try
            {
                // Get the list of all admin users
                GetCorporateInvitedUsersList result = apiInstance.GetCorporateInvitedUsersList();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.GetCorporateInvitedUsersList: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

GetCorporateInvitedUsersList

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCorporateUserPermission

GetCorporateUserPermission GetCorporateUserPermission (string email)

Check admin user permissions

This endpoint will provide the list of admin user permissions

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class GetCorporateUserPermissionExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var email = email_example;  // string | Email of the invited user

            try
            {
                // Check admin user permissions
                GetCorporateUserPermission result = apiInstance.GetCorporateUserPermission(email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.GetCorporateUserPermission: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
email	string	Email of the invited user

Return type

GetCorporateUserPermission

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubAccountGroups

List GetSubAccountGroups ()

Get the list of groups

This endpoint allows you to list all groups created on your Admin account.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class GetSubAccountGroupsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();

            try
            {
                // Get the list of groups
                List&lt;InlineResponse2001&gt; result = apiInstance.GetSubAccountGroups();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.GetSubAccountGroups: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InviteAdminUser

InviteAdminUser InviteAdminUser (InviteAdminUser 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\" -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**: - 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.

Example

using System;
using System.Diagnostics;
using brevo_csharp.Api;
using brevo_csharp.Client;
using brevo_csharp.Model;

namespace Example
{
    public class InviteAdminUserExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new MasterAccountApi();
            var sendInvitation = new InviteAdminUser(); // InviteAdminUser | Payload to send an invitation

            try
            {
                // Send invitation to an admin user
                InviteAdminUser result = apiInstance.InviteAdminUser(sendInvitation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterAccountApi.InviteAdminUser: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
sendInvitation	InviteAdminUser	Payload to send an invitation

Return type

InviteAdminUser

Authorization

api-key, partner-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

MasterAccountApi.md

Latest commit

History

MasterAccountApi.md

File metadata and controls

brevo_csharp.Api.MasterAccountApi

CorporateGroupIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateGroupIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateGroupIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateGroupPost

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateGroupUnlinkGroupIdSubAccountsPut

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateIpGet

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateMasterAccountGet

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateSsoTokenPost

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateSubAccountGet

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateSubAccountIdApplicationsTogglePut

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateSubAccountIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateSubAccountIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

CorporateSubAccountIdPlanPut