Brevo

Brevo User API

The user API from Brevo — 6 operation(s) for user.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /organization/invited/users List users in the organization · Get the list of all your users #
Ask an LLM
“Who has access to my Brevo organization, including pending invites?”
“Which of my invited users haven't accepted yet?”
Tell an agent
List all users in my organization.
Show active and pending users using API key {api_key}.
GET /organization/user/{email}/permissions Check a user's feature permissions · Check user permission #
Ask an LLM
“What features can a specific teammate access in our organization?”
“Does a given user have permission to send email campaigns?”
Tell an agent
Check the permissions of user {email}.
Show the feature-level access granted to {email}.
PUT /organization/user/invitation/revoke/{email} Revoke a user's access · Revoke user permission #
Ask an LLM
“How do I remove a teammate's access to the organization?”
“Can I revoke all permissions for an invited user?”
Tell an agent destructive · confirm first
Revoke all permissions for user {email}.
Remove {email}'s access to the organization.
PUT /organization/user/invitation/{action}/{email} Resend or cancel a user invitation · Resend / Cancel invitation #
Ask an LLM
“Can I resend an organization invite that expired?”
“How do I cancel a pending invitation to a teammate?”
Tell an agent
Perform {action} on the pending organization invitation for {email}.
Cancel or resend the teammate invite to {email} with action {action}.
POST /organization/user/invitation/send Invite a user to the organization · Send invitation to user #
Ask an LLM
“How do I invite a colleague to our Brevo organization?”
“Can I limit an invited user to only certain features like Deals or Automations?”
Tell an agent
Invite {email} to the organization with all-features access {all_features_access}.
Invite {email} with privileges {privileges} and all-features access {all_features_access}.
POST /organization/user/update/permissions Update an existing user's permissions · Update permission for a user #
Ask an LLM
“How do I change what an existing teammate can do?”
“Can I give a current user access to every feature?”
Tell an agent
Update permissions for existing user {email} to {privileges}, all-features access {all_features_access}.
Grant current teammate {email} full access by setting all-features access {all_features_access} and privileges {privileges}.

Documentation

📖
Documentation
https://developers.brevo.com/docs/loyalty-overview
📖
APIReference
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/docs/getting-started-with-senders-and-domains
📖
Documentation
https://developers.brevo.com/docs/event-endpoints
📖
Documentation
https://developers.brevo.com/docs/custom-objects-management
📖
Documentation
https://developers.brevo.com/reference/get-wallet-pass-install-url

Specifications

⚙
OpenAPI
https://artifacts.apis.io/brevo/openapi/brevo-user-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/brevo/asyncapi/brevo-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-user-get-user-permission-response-200-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-inviteuser-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-user-edit-user-permission-response-200-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-user-putresendcancelinvitation-response-200-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-user-put-revoke-user-permission-response-200-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-user-get-invited-users-list-response-200-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/brevo:brevo-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

brevo-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Accounts and Settings User API
  version: 1.0.0
servers:
- url: https://api.brevo.com/v3
  description: https://api.brevo.com/v3
tags:
- name: User
paths:
  /organization/invited/users:
    get:
      operationId: getInvitedUsersList
      summary: Get the list of all your users
      description: Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.
      tags:
      - User
      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 your users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_getInvitedUsersList_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInvitedUsersListRequestBadRequestError'
  /organization/user/{email}/permissions:
    get:
      operationId: getUserPermission
      summary: Check user permission
      description: Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user''s current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.
      tags:
      - User
      parameters:
      - name: email
        in: path
        description: Email of the invited user.
        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: list of all the user's permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_getUserPermission_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserPermissionRequestBadRequestError'
  /organization/user/invitation/revoke/{email}:
    put:
      operationId: putRevokeUserPermission
      summary: Revoke user permission
      description: Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user''s plan change generated credit notes, they are returned in the response for billing reconciliation.
      tags:
      - User
      parameters:
      - name: email
        in: path
        description: Email of the invited user.
        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: Credit note exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_putRevokeUserPermission_Response_200'
        '403':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutRevokeUserPermissionRequestForbiddenError'
  /organization/user/invitation/{action}/{email}:
    put:
      operationId: putresendcancelinvitation
      summary: Resend / Cancel invitation
      description: Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user''s pending access.
      tags:
      - User
      parameters:
      - name: action
        in: path
        description: action
        required: true
        schema:
          $ref: '#/components/schemas/OrganizationUserInvitationActionEmailPutParametersAction'
      - name: email
        in: path
        description: Email of the invited user.
        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: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_putresendcancelinvitation_Response_200'
        '403':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutresendcancelinvitationRequestForbiddenError'
  /organization/user/invitation/send:
    post:
      operationId: inviteuser
      summary: Send invitation to user
      description: '`Feature` - A Feature represents a specific functionality like Email

        campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user,

        determine which feature you want to manage access to. You must specify the

        feature accurately to avoid errors. `Permission` - A Permission defines the

        level of access or control a user has over a specific feature. While

        inviting user, decide on the permission level required for the selected

        feature. Make sure the chosen permission is related to the selected feature.

        Features and their respective permissions are as below: - `email_campaigns`:

        - "create_edit_delete"

        - "send_schedule_suspend"

        - `sms_campaigns`:

        - "create_edit_delete"

        - "send_schedule_suspend"

        - `contacts`:

        - "view"

        - "create_edit_delete"

        - "import"

        - "export"

        - "list_and_attributes"

        - "forms"

        - `templates`:

        - "create_edit_delete"

        - "activate_deactivate"

        - `workflows`:

        - "create_edit_delete"

        - "activate_deactivate_pause"

        - "settings"

        - `landing_pages`:

        - "all"

        - `transactional_emails`:

        - "settings"

        - "logs"

        - `smtp_api`:

        - "smtp"

        - "api_keys"

        - "authorized_ips"

        - `user_management`:

        - "all"

        - `sales_platform`:

        - "create_edit_deals"

        - "delete_deals"

        - "manage_others_deals_tasks"

        - "reports"

        - "settings"

        - `phone`:

        - "all"

        - `conversations`:

        - "access"

        - "assign"

        - "configure"

        - `senders_domains_dedicated_ips`:

        - "senders_management"

        - "domains_management"

        - "dedicated_ips_management"

        - `push_notifications`:

        - "view"

        - "create_edit_delete"

        - "send"

        - "settings"

        - `companies`:

        - "manage_owned_companies"

        - "manage_other_companies"

        - "settings"

        **Note**: - If `all_features_access: false` then only privileges are

        required otherwise if `true` then it''s assumed that all permissions will be

        there for the invited user. - The availability of feature and its permission

        depends on your current plan. Please select the features and permissions

        accordingly.'
      tags:
      - User
      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: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_inviteuser_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteuserRequestBadRequestError'
      requestBody:
        description: Values to create an invitation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/inviteuser'
  /organization/user/update/permissions:
    post:
      operationId: EditUserPermission
      summary: Update permission for a user
      description: '`Feature` - A Feature represents a specific functionality like Email

        campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user,

        determine which feature you want to manage access to. You must specify the

        feature accurately to avoid errors. `Permission` - A Permission defines the

        level of access or control a user has over a specific feature. While

        inviting user, decide on the permission level required for the selected

        feature. Make sure the chosen permission is related to the selected feature.

        Features and their respective permissions are as below: - `email_campaigns`:

        - "create_edit_delete"

        - "send_schedule_suspend"

        - `sms_campaigns`:

        - "create_edit_delete"

        - "send_schedule_suspend"

        - `contacts`:

        - "view"

        - "create_edit_delete"

        - "import"

        - "export"

        - "list_and_attributes"

        - "forms"

        - `templates`:

        - "create_edit_delete"

        - "activate_deactivate"

        - `workflows`:

        - "create_edit_delete"

        - "activate_deactivate_pause"

        - "settings"

        - `landing_pages`:

        - "all"

        - `transactional_emails`:

        - "settings"

        - "logs"

        - `smtp_api`:

        - "smtp"

        - "api_keys"

        - "authorized_ips"

        - `user_management`:

        - "all"

        - `sales_platform`:

        - "create_edit_deals"

        - "delete_deals"

        - "manage_others_deals_tasks"

        - "reports"

        - "settings"

        - `phone`:

        - "all"

        - `conversations`:

        - "access"

        - "assign"

        - "configure"

        - `senders_domains_dedicated_ips`:

        - "senders_management"

        - "domains_management"

        - "dedicated_ips_management"

        - `push_notifications`:

        - "view"

        - "create_edit_delete"

        - "send"

        - "settings"

        - `companies`:

        - "manage_owned_companies"

        - "manage_other_companies"

        - "settings"

        **Note**: - The privileges array remains the same as in the send invitation;

        the user simply needs to provide the permissions that need to be updated. -

        The availability of feature and its permission depends on your current plan.

        Please select the features and permissions accordingly.'
      tags:
      - User
      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: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_EditUserPermission_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EditUserPermissionRequestBadRequestError'
      requestBody:
        description: Values to create an invitation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/inviteuser'
components:
  schemas:
    OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaPrivilegesItems:
      type: object
      properties:
        feature:
          type: string
        permissions:
          type: array
          items:
            type: string
      required:
      - feature
      - permissions
      title: OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaPrivilegesItems
    OrganizationUserUpdatePermissionsPostResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: OrganizationUserUpdatePermissionsPostResponsesContentApplicationJsonSchemaCode
    InviteuserPrivilegesItems:
      type: object
      properties:
        feature:
          $ref: '#/components/schemas/InviteuserPrivilegesItemsFeature'
          description: Feature name
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/InviteuserPrivilegesItemsPermissionsItems'
          description: Permissions for a given feature
      description: Privileges given to the user
      title: InviteuserPrivilegesItems
    InviteuserPrivilegesItemsFeature:
      type: string
      enum:
      - email_campaigns
      - sms_campaigns
      - contacts
      - templates
      - workflows
      - landing_pages
      - transactional_emails
      - smtp_api
      - user_management
      - sales_platform
      - phone
      - conversations
      - senders_domains_dedicated_ips
      - push_notifications
      - companies
      description: Feature name
      title: InviteuserPrivilegesItemsFeature
    InviteuserRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/OrganizationUserInvitationSendPostResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: InviteuserRequestBadRequestError
    OrganizationUserInvitationActionEmailPutParametersAction:
      type: string
      enum:
      - resend
      - cancel
      title: OrganizationUserInvitationActionEmailPutParametersAction
    OrganizationUserInvitationActionEmailPutResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: OrganizationUserInvitationActionEmailPutResponsesContentApplicationJsonSchemaCode
    GetUserPermissionRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: GetUserPermissionRequestBadRequestError
    User_getInvitedUsersList_Response_200:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems'
          description: Get invited users list
      title: User_getInvitedUsersList_Response_200
    OrganizationUserInvitationRevokeEmailPutResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: OrganizationUserInvitationRevokeEmailPutResponsesContentApplicationJsonSchemaCode
    OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess:
      type: object
      properties:
        conversations:
          type: string
          description: Conversations features accessiblity.
        crm:
          type: string
          description: CRM features accessiblity.
        marketing:
          type: string
          description: Marketing features accessiblity.
      description: Feature accessiblity given to the user.
      title: OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess
    PutresendcancelinvitationRequestForbiddenError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/OrganizationUserInvitationActionEmailPutResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: PutresendcancelinvitationRequestForbiddenError
    InviteuserPrivilegesItemsPermissionsItems:
      type: string
      enum:
      - create_edit_delete
      - send_schedule_suspend
      - view
      - import
      - export
      - list_and_attributes
      - forms
      - activate_deactivate
      - activate_deactivate_pause
      - settings
      - schedule_pause
      - all
      - logs
      - access
      - assign
      - configure
      - create_edit_deals
      - delete_deals
      - manage_others_deals_tasks
      - manage_owned_companies
      - manage_others_companies
      - reports
      - senders_management
      - domains_management
      - dedicated_ips_management
      - send
      - smtp
      - api_keys
      - authorized_ips
      - none
      title: InviteuserPrivilegesItemsPermissionsItems
    User_getUserPermission_Response_200:
      type: object
      properties:
        email:
          type: string
          description: Email address of the user.
        privileges:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaPrivilegesItems'
          description: Granular feature permissions given to the user.
        status:
          type: string
          description: Status of the invited user.
      required:
      - email
      - privileges
      - status
      description: Check user permission
      title: User_getUserPermission_Response_200
    EditUserPermissionRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/OrganizationUserUpdatePermissionsPostResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: EditUserPermissionRequestBadRequestError
    OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaCode
    OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode
    User_putRevokeUserPermission_Response_200:
      type: object
      properties:
        credit_notes:
          type: array
          items:
            type: string
          description: Credit note
        status:
          type: string
          description: Status of the API operation.
      required:
      - status
      title: User_putRevokeUserPermission_Response_200
    User_inviteuser_Response_200:
      type: object
      properties:
        invoice_id:
          type: string
          description: Invoice id
        status:
          type: string
          description: Status of the API operation.
      required:
      - status
      title: User_inviteuser_Response_200
    GetInvitedUsersListRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: GetInvitedUsersListRequestBadRequestError
    User_EditUserPermission_Response_200:
      type: object
      properties:
        credit_notes:
          type: array
          items:
            type: string
          description: Credit note
        invoice_id:
          type: string
          description: Invoice id
        status:
          type: string
          description: Status of the API operation.
      required:
      - status
      title: User_EditUserPermission_Response_200
    User_putresendcancelinvitation_Response_200:
      type: object
      properties:
        credit_notes:
          type: array
          items:
            type: string
          description: Credit note
        status:
          type: string
          description: Status of the API operation.
      required:
      - status
      title: User_putresendcancelinvitation_Response_200
    inviteuser:
      type: object
      properties:
        all_features_access:
          type: boolean
          description: All access to the features
        email:
          type: string
          format: email
          description: Email address for the organization
        privileges:
          type: array
          items:
            $ref: '#/components/schemas/InviteuserPrivilegesItems'
      required:
      - all_features_access
      - email
      - privileges
      title: inviteuser
    PutRevokeUserPermissionRequestForbiddenError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/OrganizationUserInvitationRevokeEmailPutResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: PutRevokeUserPermissionRequestForbiddenError
    OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems:
      type: object
      properties:
        email:
          type: string
          description: Email address of the user.
        feature_access:
          $ref: '#/components/schemas/OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess'
          description: Feature accessiblity given to the user.
        is_owner:
          type: string
          description: Flag for indicating is user owner of the organization.
        status:
          type: string
          description: Status of the invited user.
      required:
      - email
      - feature_access
      - is_owner
      - status
      title: OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems
    OrganizationUserInvitationSendPostResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: OrganizationUserInvitationSendPostResponsesContentApplicationJsonSchemaCode
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: api-key
      description: The API key should be passed in the request headers as `api-key` for authentication.