Skip to content

Latest commit

 

History

History
236 lines (146 loc) · 8.91 KB

MasterAccountApi.md

File metadata and controls

236 lines (146 loc) · 8.91 KB

\MasterAccountApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
CorporateMasterAccountGet Get /corporate/masterAccount Get the details of requested master account
CorporateSubAccountGet Get /corporate/subAccount Get the list of all the sub-accounts of the master account.
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
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 Sendinblue

CorporateMasterAccountGet

MasterDetailsResponse CorporateMasterAccountGet(ctx, ) Get the details of requested master account

This endpoint will provide the details of the master account.

Required 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]

CorporateSubAccountGet

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.

Required Parameters

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

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]

CorporateSubAccountIdDelete

CorporateSubAccountIdDelete(ctx, id) Delete a sub-account

Required Parameters

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

Return type

(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(ctx, id) Get sub-account details

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 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

CorporateSubAccountIdPlanPut(ctx, id, updatePlanDetails) Update sub-account plan

This endpoint will update the sub-account plan

Required Parameters

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

Return type

(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(ctx, createApiKeyRequest) Create an API key for a sub-account

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

Required Parameters

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

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(ctx, subAccountCreate) Create a new sub-account under a master account.

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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(ctx, ssoTokenRequest) Generate SSO token to access Sendinblue

This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.

Required Parameters

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

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]