All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| AddCredits | Post /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account |
| AssociateIpToChild | Post /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child |
| CreateChildDomain | Post /reseller/children/{childIdentifier}/domains | Create a domain for a child account |
| CreateResellerChild | Post /reseller/children | Creates a reseller child |
| DeleteChildDomain | Delete /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed |
| DeleteResellerChild | Delete /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied |
| DissociateIpFromChild | Post /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child |
| GetChildAccountCreationStatus | Get /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied |
| GetChildDomains | Get /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account |
| GetChildInfo | Get /reseller/children/{childIdentifier} | Get a child account's details |
| GetResellerChilds | Get /reseller/children | Get the list of all children accounts |
| GetSsoToken | Get /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO) |
| RemoveCredits | Post /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account |
| UpdateChildAccountStatus | Put /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied |
| UpdateChildDomain | Put /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed |
| UpdateResellerChild | Put /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied |
RemainingCreditModel AddCredits(ctx, childIdentifier, addCredits) Add Email and/or SMS credits to a specific child account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| addCredits | AddCredits | Values to post to add credit to a specific child account |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AssociateIpToChild(ctx, childIdentifier, ip) Associate a dedicated IP to the child
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| ip | ManageIp | IP to associate |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateChildDomain(ctx, childIdentifier, addChildDomain) Create a domain for a child account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| addChildDomain | AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent 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]
CreateReseller CreateResellerChild(ctx, optional) Creates a reseller child
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *CreateResellerChildOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CreateResellerChildOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| resellerChild | optional.Interface of CreateChild | reseller child to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteChildDomain(ctx, childIdentifier, domainName) Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| domainName | string | Pass the existing domain that needs 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]
DeleteResellerChild(ctx, childIdentifier) Delete a single reseller child based on the child identifier supplied
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or child id of reseller's child |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DissociateIpFromChild(ctx, childIdentifier, ip) Dissociate a dedicated IP to the child
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| ip | ManageIp | IP to dissociate |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetChildAccountCreationStatus GetChildAccountCreationStatus(ctx, childIdentifier) Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetChildDomains GetChildDomains(ctx, childIdentifier) Get all sender domains for a specific child account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetChildInfo GetChildInfo(ctx, childIdentifier) Get a child account's details
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetChildrenList GetResellerChilds(ctx, optional) Get the list of all children accounts
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetResellerChildsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetResellerChildsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int64 | Number of documents for child accounts information 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]
GetSsoToken GetSsoToken(ctx, childIdentifier) Get session token to access Brevo (SSO)
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemainingCreditModel RemoveCredits(ctx, childIdentifier, removeCredits) Remove Email and/or SMS credits from a specific child account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| removeCredits | RemoveCredits | Values to post to remove email or SMS credits from a specific child account |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateChildAccountStatus(ctx, childIdentifier, updateChildAccountStatus) Update info of reseller's child account status based on the childIdentifier supplied
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| updateChildAccountStatus | UpdateChildAccountStatus | values to update in child account status |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateChildDomain(ctx, childIdentifier, domainName, updateChildDomain) Update the sender domain of reseller's child based on the childIdentifier and domainName passed
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| domainName | string | Pass the existing domain that needs to be updated | |
| updateChildDomain | UpdateChildDomain | value to update for sender domain |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateResellerChild(ctx, childIdentifier, resellerChild) Update info of reseller's child based on the child identifier supplied
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| childIdentifier | string | Either auth key or id of reseller's child | |
| resellerChild | UpdateChild | values to update in child profile |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]