Brevo Master Account API

openapi: 3.2.0
info:
  title: Accounts and Settings Master Account API
  version: 1.0.0
servers:
- url: https://api.brevo.com/v3
  description: https://api.brevo.com/v3
tags:
- name: masterAccount
paths:
  /corporate/subAccount:
    get:
      operationId: getTheListOfAllTheSubAccountsOfTheMasterAccount
      summary: Get the list of all the sub-accounts of the master account.
      description: 'This endpoint will provide the list all the sub-accounts of the master

        account.'
      tags:
      - masterAccount
      parameters:
      - name: offset
        in: query
        description: Index of the first sub-account in the page
        required: true
        schema:
          type: integer
      - name: limit
        in: query
        description: Number of sub-accounts to be displayed on each page
        required: true
        schema:
          type: integer
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Sub-accounts list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_getTheListOfAllTheSubAccountsOfTheMasterAccount_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTheListOfAllTheSubAccountsOfTheMasterAccountRequestBadRequestError'
    post:
      operationId: createANewSubAccountUnderAMasterAccount
      summary: Create a new sub-account under a master account.
      description: This endpoint will create a new sub-account under a master account
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created sub-account ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_createANewSubAccountUnderAMasterAccount_Response_201'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Request body with sub-account organization name
        content:
          application/json:
            schema:
              type: object
              properties:
                companyName:
                  type: string
                  description: Set the name of the sub-account company
                email:
                  type: string
                  description: Email address for the organization
                groupIds:
                  type: array
                  items:
                    type: string
                  description: Set the group(s) for the sub-account
                language:
                  $ref: '#/components/schemas/CorporateSubAccountPostRequestBodyContentApplicationJsonSchemaLanguage'
                  description: Set the language of the sub-account
                timezone:
                  type: string
                  description: Set the timezone of the sub-account
              required:
              - companyName
              - email
  /corporate/subAccount/{id}:
    get:
      operationId: getSubAccountDetails
      summary: Get sub-account details
      description: This endpoint will provide the details for the specified sub-account company
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the sub-account organization
        required: true
        schema:
          type: integer
          format: int64
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Sub-account organization details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_getSubAccountDetails_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubAccountDetailsRequestBadRequestError'
    delete:
      operationId: deleteASubAccount
      summary: Delete a sub-account
      description: Permanently deletes a sub-account from the corporate master account. Once deleted, all data associated with the sub-account organization is removed and cannot be recovered, so ensure the sub-account is no longer needed before proceeding.
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the sub-account organization to be deleted
        required: true
        schema:
          type: integer
          format: int64
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Returned when sub-account is deleted succesfully
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: sub-account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
  /corporate/subAccount/{id}/plan:
    put:
      operationId: updateSubAccountPlan
      summary: Update sub-account plan
      description: '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.'
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the sub-account organization
        required: true
        schema:
          type: integer
          format: int64
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Sub account plan updated
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubAccountPlanRequestBadRequestError'
        '403':
          description: Current account is not a master account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Values to update a sub-account plan
        content:
          application/json:
            schema:
              type: object
              properties:
                credits:
                  $ref: '#/components/schemas/CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaCredits'
                  description: Credit details to update
                features:
                  $ref: '#/components/schemas/CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaFeatures'
                  description: Features details to update
  /corporate/subAccounts/plan:
    put:
      operationId: updateSubAccountsPlan
      summary: Update sub-accounts plan
      description: '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.'
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_updateSubAccountsPlan_Response_202'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubAccountsPlanRequestBadRequestError'
        '403':
          description: Current account is not a master account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Values to update sub-accounts plan
        content:
          application/json:
            schema:
              type: object
              properties:
                credits:
                  $ref: '#/components/schemas/CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaCredits'
                  description: Credit details to update
                features:
                  $ref: '#/components/schemas/CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaFeatures'
                  description: Features details to update
                subAccountIds:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: List of sub-account ids
  /corporate/ssoToken:
    post:
      operationId: generateSsoTokenToAccessAdminAccount
      summary: Generate SSO token to access admin account
      description: '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.'
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Session token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSsoToken'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Current account is not an admin account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: User email of admin account
              required:
              - email
  /corporate/subAccount/ssoToken:
    post:
      operationId: generateSsoTokenToAccessSubAccount
      summary: Generate SSO token to access sub-account
      description: '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.'
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Session token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSsoToken'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Current account is not a master account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: User email of sub-account organization
                id:
                  type: integer
                  format: int64
                  description: Id of the sub-account organization
                target:
                  $ref: '#/components/schemas/CorporateSubAccountSsoTokenPostRequestBodyContentApplicationJsonSchemaTarget'
                  description: '**Set target after login success** * **automation** - Redirect

                    to Automation after login * **email_campaign** - Redirect to

                    Email Campaign after login * **contacts** - Redirect to Contacts

                    after login * **landing_pages** - Redirect to Landing Pages

                    after login * **email_transactional** - Redirect to Email

                    Transactional after login * **senders** - Redirect to Senders

                    after login * **sms_campaign** - Redirect to Sms Campaign after

                    login * **sms_transactional** - Redirect to Sms Transactional

                    after login'
                url:
                  type: string
                  description: 'Set the full target URL after login success. The user will land

                    directly on this target URL after login'
              required:
              - id
  /corporate/masterAccount:
    get:
      operationId: getTheDetailsOfRequestedMasterAccount
      summary: Get the details of requested master account
      description: This endpoint will provide the details of the master account.
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Master account details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_getTheDetailsOfRequestedMasterAccount_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTheDetailsOfRequestedMasterAccountRequestBadRequestError'
  /corporate/subAccount/key:
    post:
      operationId: createAnApiKeyForASubAccount
      summary: Create an API key for a sub-account
      description: This endpoint will generate an API v3 key for a sub-account
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_createAnApiKeyForASubAccount_Response_201'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
                  description: Id of the sub-account organization
                name:
                  type: string
                  description: Name of the API key
              required:
              - id
              - name
  /corporate/subAccount/{id}/applications/toggle:
    put:
      operationId: enableDisableSubAccountApplicationS
      summary: Enable/disable sub-account application(s)
      description: 'API endpoint for the Corporate owner to enable/disable applications on the

        sub-account'
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the sub-account organization (mandatory)
        required: true
        schema:
          type: integer
          format: int64
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Sub-account application(s) enabled/disabled
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnableDisableSubAccountApplicationSRequestBadRequestError'
        '403':
          description: Current account is not a master account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: List of applications to activate or deactivate on a sub-account
        content:
          application/json:
            schema:
              type: object
              properties:
                automation:
                  type: boolean
                  description: 'Set this field to enable or disable Automation on the

                    sub-account'
                conversations:
                  type: boolean
                  description: 'Set this field to enable or disable Conversations on the

                    sub-account'
                crm:
                  type: boolean
                  description: Set this field to enable or disable Sales CRM on the sub-account
                email-campaigns:
                  type: boolean
                  description: 'Set this field to enable or disable Email Campaigns on the

                    sub-account'
                facebook-ads:
                  type: boolean
                  description: 'Set this field to enable or disable Facebook ads on the

                    sub-account'
                inbox:
                  type: boolean
                  description: 'Set this field to enable or disable Inbox on the sub-account /

                    Not applicable on ENTv2'
                landing-pages:
                  type: boolean
                  description: 'Set this field to enable or disable Landing pages on the

                    sub-account'
                meetings:
                  type: boolean
                  description: Set this field to enable or disable Meetings on the sub-account
                sms-campaigns:
                  type: boolean
                  description: 'Set this field to enable or disable SMS Marketing on the

                    sub-account'
                transactional-emails:
                  type: boolean
                  description: 'Set this field to enable or disable Transactional Email on the

                    sub-account'
                transactional-sms:
                  type: boolean
                  description: 'Set this field to enable or disable Transactional SMS on the

                    sub-account'
                web-push:
                  type: boolean
                  description: Set this field to enable or disable Web Push on the sub-account
                whatsapp:
                  type: boolean
                  description: 'Set this field to enable or disable Whatsapp campaigns on the

                    sub-account'
  /corporate/group:
    post:
      operationId: createANewGroupOfSubAccounts
      summary: Create a new group of sub-accounts
      description: This endpoint allows to create a group of sub-accounts
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Group ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_createANewGroupOfSubAccounts_Response_201'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                groupName:
                  type: string
                  description: The name of the group of sub-accounts
                subAccountIds:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: Pass the list of sub-account Ids to be included in the group
              required:
              - groupName
  /corporate/ip:
    get:
      operationId: listOfAllIPs
      summary: List of all IPs
      description: 'This endpoint allows you to retrieve the list of active IPs on your Admin

        account'
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of all IPs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CorporateIpGetResponsesContentApplicationJsonSchemaItems'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
  /corporate/subAccount/ip/associate:
    post:
      operationId: associateAnIpToSubAccounts
      summary: Associate an IP to sub-accounts
      description: This endpoint allows to associate an IP to sub-accounts
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: IP has been associated with sub-accounts successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_associateAnIpToSubAccounts_Response_201'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: 'Pass the list of sub-account Ids to be associated with the IP

                    address'
                ip:
                  type: string
                  description: IP address
              required:
              - ids
              - ip
  /corporate/subAccount/ip/dissociate:
    put:
      operationId: dissociateAnIpToSubAccounts
      summary: Dissociate an IP to sub-accounts
      description: This endpoint allows to dissociate an IP from sub-accounts
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: IP has been dissociated from sub-accounts successfully
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: 'Pass the list of sub-account Ids to be dissociated from the IP

                    address'
                ip:
                  type: string
                  description: IP address
              required:
              - ids
              - ip
  /corporate/group/{id}:
    get:
      operationId: getAGroupDetails
      summary: GET a group details
      description: '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.'
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the group of sub-organization
        required: true
        schema:
          type: string
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Group details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master_account_getAGroupDetails_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    put:
      operationId: updateAGroupOfSubAccounts
      summary: Update a group of sub-accounts
      description: This endpoint allows to update a group of sub-accounts
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the group
        required: true
        schema:
          type: string
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Group details updated
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Group details to be updated.
        content:
          application/json:
            schema:
              type: object
              properties:
                groupName:
                  type: string
                  description: The name of the group of sub-accounts
                subAccountIds:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: Pass the list of sub-account Ids to be included in the group
    delete:
      operationId: deleteAGroup
      summary: Delete a group
      description: '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.'
      tags:
      - masterAccount
      parameters:
      - name: id
        in: path
        description: Id of the group
        required: true
        schema:
          type: string
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Group deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
  /corporate/group/unlink/{groupId}/subAccounts:
    put:
      operationId: deleteSubAccountFromGroup
      summary: Delete sub-account from group
      description: This endpoint allows you to remove a sub-organization from a group.
      tags:
      - masterAccount
      parameters:
      - name: groupId
        in: path
        description: Group id
        required: true
        schema:
          type: string
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: SubAccounts removed from the group
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: List of sub-account ids
        content:
          application/json:
            schema:
              type: object
              properties:
                subAccountIds:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: List of sub-account ids
              required:
              - subAccountIds
  /corporate/user/invitation/send:
    post:
      operationId: inviteAdminUser
      summary: Send invitation to an admin user
      description: "`This endpoint allows you to invite a member to manage the Admin account\nFeatures and their respective permissions are as below: - `my_plan`:\n  - \"all\"\n- `api`:\n  - \"none\"\n- `user_management`:\n  - \"all\"\n- `app_management` | Not available in ENTv2:\n  - \"all\"\n- `sub_organization_groups`\n  - \"create\"\n  - \"edit_delete\"\n- `create_sub_organizations`\n  - \"all\"\n- `manage_sub_organizations`\n  - \"all\"\n- `analytics`\n  - \"download_data\"\n  - \"create_alerts\"\n  - \"my_looks\"\n  - \"explore_create\"\n- `security`\n  - \"all\"\n**Note**: - If `all_features_access: false` then only privileges are\nrequired otherwise if `true` then it's assumed that all permissions will be\nthere for the invited admin user."
      tags:
      - masterAccount
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Invitation ID
          content:
            application/json:
              schema:
                $ref: '#/compone

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/openapi/brevo-masteraccount-api-openapi.yml