API Evangelist conversational phrasing for Accounts and Settings Master Account API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounts and Settings Master Account API
  version: 1.0.0
extends: openapi/brevo-master-account-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 26
- target: $.paths['/corporate/subAccount'].get
  update:
    x-apievangelist-phrasing:
      intent: List all sub-accounts under the master account
      effect: read
      questions:
      - Which sub-accounts sit under my Brevo corporate master account?
      - Can I page through every sub-organization my admin account manages?
      instructions:
      - text: List the first {limit} sub-accounts of my master account.
        slots:
          limit: query.limit
      - text: Show sub-accounts of the master account starting at offset {offset}, {limit} per page.
        slots:
          offset: query.offset
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new sub-account
      effect: write
      questions:
      - How do I spin up a new sub-account for a client under my corporate account?
      - Can I set the language and timezone when creating a sub-organization?
      instructions:
      - text: Create a sub-account for company {companyName} with login email {email}.
        slots:
          companyName: requestBody.companyName
          email: requestBody.email
      - text: Create sub-account {companyName} for {email} in timezone {timezone} with language {language}.
        slots:
          companyName: requestBody.companyName
          email: requestBody.email
          timezone: requestBody.timezone
          language: requestBody.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one sub-account
      effect: read
      questions:
      - What plan, credits and company info does a specific sub-account have?
      - Where can I see the details of a single sub-organization by its ID?
      instructions:
      - text: Get the details of sub-account {id}.
        slots:
          id: path.id
      - text: Show me the company info and plan for sub-organization {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a sub-account
      effect: destructive
      questions:
      - Can I permanently remove a sub-account and all its data from my master account?
      - What happens to a sub-organization's data when it is deleted?
      instructions:
      - text: Delete sub-account {id} permanently.
        slots:
          id: path.id
      - text: Remove sub-organization {id} from my corporate account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/{id}/plan'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one sub-account's plan and credits
      effect: write
      questions:
      - How do I give a single sub-account more email or SMS credits?
      - Can I change which plan features one sub-organization gets?
      instructions:
      - text: Update the plan credits of sub-account {id} to {credits}.
        slots:
          id: path.id
          credits: requestBody.credits
      - text: Set the plan features for sub-account {id} to {features}.
        slots:
          id: path.id
          features: requestBody.features
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccounts/plan'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the plan for several sub-accounts at once
      effect: write
      questions:
      - Can I update credits for many sub-accounts in one request?
      - Is there a bulk way to change plan features across multiple sub-organizations?
      instructions:
      - text: Apply credits {credits} to sub-accounts {subAccountIds} in one bulk plan update.
        slots:
          credits: requestBody.credits
          subAccountIds: requestBody.subAccountIds
      - text: Bulk-set plan features {features} on sub-accounts {subAccountIds}.
        slots:
          features: requestBody.features
          subAccountIds: requestBody.subAccountIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/ssoToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an SSO token for the admin account
      effect: write
      questions:
      - How can an admin user log into the corporate admin account with single sign-on?
      - Can I generate a login token for the master admin account instead of a sub-account?
      instructions:
      - text: Generate an admin-account SSO token for user {email}.
        slots:
          email: requestBody.email
      - text: Create a single sign-on token so {email} can access the corporate admin account.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/ssoToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an SSO token to access a sub-account
      effect: write
      questions:
      - How do I log into a client's sub-account from the master account without a password?
      - Can an SSO token for a sub-account land the user on a specific page?
      instructions:
      - text: Generate an SSO token to access sub-account {id}.
        slots:
          id: requestBody.id
      - text: Create a sub-account SSO token for sub-account {id} as user {email} that redirects to {url}.
        slots:
          id: requestBody.id
          email: requestBody.email
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/masterAccount'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the master account's details
      effect: read
      questions:
      - What are the details and plan of my corporate master account?
      - Where do I see the admin account's own company information?
      instructions:
      - text: Get the details of my master account.
      - text: Show the corporate admin account's plan and company info using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key for a sub-account
      effect: write
      questions:
      - Can I generate an API v3 key for one of my sub-accounts from the master account?
      - How do I give a sub-organization its own API key?
      instructions:
      - text: Create an API key named {name} for sub-account {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Generate a new v3 API key called {name} on sub-organization {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/{id}/applications/toggle'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable apps on a sub-account
      effect: write
      questions:
      - Can I turn off SMS campaigns or WhatsApp for a specific sub-account?
      - Which applications, like CRM, inbox or landing pages, can I toggle per sub-organization?
      instructions:
      - text: On sub-account {id}, set CRM to {crm} and conversations to {conversations}.
        slots:
          id: path.id
          crm: requestBody.crm
          conversations: requestBody.conversations
      - text: Toggle WhatsApp to {whatsapp} for sub-account {id}.
        slots:
          whatsapp: requestBody.whatsapp
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group of sub-accounts
      effect: write
      questions:
      - How do I organize my sub-accounts into groups?
      - Can I create a sub-account group and add members in the same call?
      instructions:
      - text: Create a sub-account group named {groupName}.
        slots:
          groupName: requestBody.groupName
      - text: Create group {groupName} containing sub-accounts {subAccountIds}.
        slots:
          groupName: requestBody.groupName
          subAccountIds: requestBody.subAccountIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/ip'].get
  update:
    x-apievangelist-phrasing:
      intent: List active IPs on the admin account
      effect: read
      questions:
      - Which dedicated IPs are active on my corporate admin account?
      - What IP addresses can I assign to my sub-accounts?
      instructions:
      - text: List all active IPs on my admin account.
      - text: Show the IP addresses available to share with sub-accounts, authenticating with {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/ip/associate'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate an IP with sub-accounts
      effect: write
      questions:
      - How do I let several sub-accounts send from one of my dedicated IPs?
      - Can I attach the same IP to multiple sub-organizations?
      instructions:
      - text: Associate IP {ip} with sub-accounts {ids}.
        slots:
          ip: requestBody.ip
          ids: requestBody.ids
      - text: Give sub-accounts {ids} access to send from IP {ip}.
        slots:
          ids: requestBody.ids
          ip: requestBody.ip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/subAccount/ip/dissociate'].put
  update:
    x-apievangelist-phrasing:
      intent: Dissociate an IP from sub-accounts
      effect: write
      questions:
      - How do I stop some sub-accounts from using a particular IP?
      - Can I detach a dedicated IP from several sub-organizations at once?
      instructions:
      - text: Dissociate IP {ip} from sub-accounts {ids}.
        slots:
          ip: requestBody.ip
          ids: requestBody.ids
      - text: Remove IP {ip} from sub-organizations {ids}.
        slots:
          ip: requestBody.ip
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/group/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sub-account group's details
      effect: read
      questions:
      - Which sub-organizations and users belong to a specific group?
      - What does one sub-account group contain?
      instructions:
      - text: Look up sub-account group {id} and its members.
        slots:
          id: path.id
      - text: Show the sub-organizations and users in group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/group/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or change members of a sub-account group
      effect: write
      questions:
      - Can I rename an existing group of sub-accounts?
      - How do I change which sub-accounts are in a group I already made?
      instructions:
      - text: Rename sub-account group {id} to {groupName}.
        slots:
          id: path.id
          groupName: requestBody.groupName
      - text: Set the members of group {id} to sub-accounts {subAccountIds}.
        slots:
          id: path.id
          subAccountIds: requestBody.subAccountIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/group/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sub-account group
      effect: destructive
      questions:
      - What happens to the sub-organizations when I delete their group?
      - Can I remove a whole group of sub-accounts I no longer need?
      instructions:
      - text: Delete sub-account group {id}.
        slots:
          id: path.id
      - text: Remove the group {id} from my admin account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/group/unlink/{groupId}/subAccounts'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove sub-accounts from a group
      effect: write
      questions:
      - How do I take a sub-organization out of a group without deleting the group?
      - Can I unlink several sub-accounts from one group at once?
      instructions:
      - text: Unlink sub-accounts {subAccountIds} from group {groupId}.
        slots:
          subAccountIds: requestBody.subAccountIds
          groupId: path.groupId
      - text: Take sub-account {subAccountIds} out of group {groupId}.
        slots:
          subAccountIds: requestBody.subAccountIds
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/user/invitation/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite an admin user to the corporate account
      effect: write
      questions:
      - How do I invite a teammate to help manage my corporate admin account?
      - Can I restrict which admin features an invited member can use?
      instructions:
      - text: Invite {email} as an admin user with full feature access set to {all_features_access}.
        slots:
          email: requestBody.email
          all_features_access: requestBody.all_features_access
      - text: Send an admin invitation to {email} with privileges {privileges} and all-features access {all_features_access}.
        slots:
          email: requestBody.email
          privileges: requestBody.privileges
          all_features_access: requestBody.all_features_access
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/user/invitation/{action}/{email}'].put
  update:
    x-apievangelist-phrasing:
      intent: Resend or cancel an admin user invitation
      effect: write
      questions:
      - Can I resend an admin invitation that someone never accepted?
      - How do I cancel a pending invite to my corporate admin account?
      instructions:
      - text: Apply action {action} to the pending admin invitation for {email}.
        slots:
          action: path.action
          email: path.email
      - text: Resend the corporate admin invitation to {email} using action {action}.
        slots:
          email: path.email
          action: path.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/user/revoke/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an admin user
      effect: destructive
      questions:
      - How do I remove a member from my corporate admin account?
      - Can I revoke an admin user's access entirely by email?
      instructions:
      - text: Revoke admin user {email} from the admin account.
        slots:
          email: path.email
      - text: Remove {email} as a member of my corporate admin account.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/invited/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin users of the corporate account
      effect: read
      questions:
      - Who are the admin users on my corporate account?
      - Can I see only the pending admin invitations rather than active admins?
      instructions:
      - text: List all admin users on my corporate account.
      - text: List admin users of type {type}, {limit} at a time.
        slots:
          type: query.type
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/user/{email}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an admin user's permissions
      effect: read
      questions:
      - What permissions does a given admin user have on the corporate account?
      - Which admin features can a specific member access?
      instructions:
      - text: Check the admin permissions of {email}.
        slots:
          email: path.email
      - text: Show which corporate admin features {email} can use.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/user/{email}/permissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an admin user's permissions
      effect: write
      questions:
      - How do I change what an existing admin user is allowed to do?
      - Can I grant an admin member access to every feature later on?
      instructions:
      - text: Change the admin permissions of {email} to {privileges}, all-features access {all_features_access}.
        slots:
          email: path.email
          privileges: requestBody.privileges
          all_features_access: requestBody.all_features_access
      - text: Give admin user {email} full access by setting all-features access to {all_features_access} with privileges {privileges}.
        slots:
          email: path.email
          all_features_access: requestBody.all_features_access
          privileges: requestBody.privileges
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporate/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List all sub-account groups
      effect: read
      questions:
      - What groups of sub-accounts have I created on my admin account?
      - Can I get every sub-organization group in one list?
      instructions:
      - text: List all sub-account groups on my admin account.
      - text: Show every group I've created for my sub-organizations using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-10-01'