{
  "opencollection": "1.0.0",
  "info": {
    "name": "Accounts and Settings",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "senders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get email senders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/senders",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "ip",
                "value": "",
                "type": "query",
                "description": "Filter your senders for a specific ip. **Available for dedicated IP usage only**\n"
              },
              {
                "name": "domain",
                "value": "",
                "type": "query",
                "description": "Filter your senders for a specific domain"
              }
            ]
          },
          "docs": "Retrieves a list of all email senders from your Brevo account with optional filtering.\n\n**Use this to:**\n- Get all available senders for email campaign setup\n- Find sender details including ID, name, and email address\n- Filter senders by IP address for dedicated IP users\n- Filter senders by domain for domain-specific configurations\n- Monitor sender configuration and status\n\n**Key information returned:**\n- Sender details (ID, name, email address)\n- Sender status and verification information\n- Ass"
        },
        {
          "info": {
            "name": "Create email sender",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/senders",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new email sender in your Brevo account.\n\n**Use this to:**\n- Add new senders for email campaigns\n- Configure sender identity (name and email)\n- Associate dedicated IPs with the sender (for dedicated IP accounts)\n- Set up domain-based sender configurations\n\n**Key information returned:**\n- Created sender ID\n- DKIM and SPF configuration status\n- Success confirmation\n\n**Important considerations:**\n- Verification email sent to specified sender address\n- DKIM and SPF configuration affects del"
        },
        {
          "info": {
            "name": "Update a sender",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/senders/:senderId",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "senderId",
                "value": "",
                "type": "path",
                "description": "Id of the sender"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing email sender's configuration.\n\nUse this to:\n- Modify sender display name or email address\n- Update dedicated IP associations\n- Change sender configuration settings\n- Correct sender information\n\nKey information returned:\n- Success confirmation\n- Updated sender details"
        },
        {
          "info": {
            "name": "Delete a sender",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/senders/:senderId",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "senderId",
                "value": "",
                "type": "path",
                "description": "Id of the sender"
              }
            ]
          },
          "docs": "Deletes an email sender from your Brevo account.\n\nUse this to:\n- Remove senders that are no longer needed\n- Clean up sender configurations\n- Remove duplicate or test senders\n\nKey information returned:\n- Success confirmation message"
        },
        {
          "info": {
            "name": "Validate a sender using OTP",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/senders/:senderId/validate",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "senderId",
                "value": "",
                "type": "path",
                "description": "Id of the sender"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Validates a sender using the OTP (One-Time Password) received via email.\n\nUse this to:\n- Complete sender verification process\n- Activate a newly created sender\n- Verify ownership of the sender email address\n- Enable the sender for use in email campaigns\n\nKey information returned:\n- Success confirmation of sender verification\n- Sender activation status"
        },
        {
          "info": {
            "name": "Get all the dedicated IPs for your account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/senders/ips",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "Retrieves all dedicated IPs associated with your Brevo account.\n\nUse this to:\n- List all your dedicated IPs\n- Check the status of your dedicated IPs (active/inactive)\n- Find IP addresses and associated domains for configuration purposes\n- Monitor your IP reputation and deliverability\n- Verify available IPs for sender configuration\n\nKey information returned:\n- IP ID and address\n- Associated domain\n- Active status\n- IP configuration details"
        },
        {
          "info": {
            "name": "Get all the dedicated IPs for a specific sender",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/senders/:senderId/ips",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "senderId",
                "value": "",
                "type": "path",
                "description": "Id of the sender"
              }
            ]
          },
          "docs": "Retrieves the dedicated IPs associated with a specific sender.\n\nUse this to:\n- Check IP configuration for a sender\n- Verify dedicated IP associations\n- Get IP details for troubleshooting\n- Monitor sender IP configuration\n\nKey information returned:\n- List of associated dedicated IPs\n- IP addresses and domain configurations\n- IP status and settings"
        }
      ]
    },
    {
      "info": {
        "name": "domains",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of all sender domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/senders/domains",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "Retrieves all domains associated with the account.\n\nUse this to:\n- List all domains\n- Verify domain existence\n- Check domain authentication and verification status\n- Monitor domain configuration and provider information\n- Review domain creation history and ownership\n\nKey information returned:\n- Domain details (ID, name, authentication status)\n- Verification and authentication states\n- Associated IP addresses and DNS providers\n- Creator information and creation timestamps\n- Pagination information"
        },
        {
          "info": {
            "name": "Create a new sender domain",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/senders/domains",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new domain in Brevo.\n\nUse this to:\n- Add new domains for sending emails\n- Set up domain authentication for better deliverability\n- Configure DNS records for email authentication\n- Establish domain-based sender identities\n\nKey information returned:\n- Created domain ID and configuration\n- Required DNS records for authentication\n- Domain provider detection results\n- Setup instructions and next steps"
        },
        {
          "info": {
            "name": "Get a sender domain configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/senders/domains/:domainName",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "domainName",
                "value": "",
                "type": "path",
                "description": "Domain name"
              }
            ]
          },
          "docs": "Retrieves configuration of a specific domain, to know if the domain is valid or not.\n\nUse this to:\n- Check domain configuration\n- Validate a domain configuration\n- Monitor DNS record status\n- Troubleshoot authentication issues\n\nKey information returned:\n- Domain verification and authentication status\n- DNS records configuration and validation status\n- Detailed authentication requirements"
        },
        {
          "info": {
            "name": "Delete a sender domain",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/senders/domains/:domainName",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "domainName",
                "value": "",
                "type": "path",
                "description": "Domain name"
              }
            ]
          },
          "docs": "Deletes a domain from Brevo.\n\nUse this to:\n- Remove existing domains\n- Clean up unused domain configurations\n- Remove test domains\n\nKey information returned:\n- Success confirmation message"
        },
        {
          "info": {
            "name": "Authenticate a sender domain",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/senders/domains/:domainName/authenticate",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "domainName",
                "value": "",
                "type": "path",
                "description": "Domain name"
              }
            ]
          },
          "docs": "Authenticates a specific domain.\n\nUse this to:\n- Authenticate a domain\n- Verify DNS record configuration\n- Complete domain setup for sending\n- Enable domain for email authentication\n\nKey information returned:\n- Authentication success confirmation\n- Domain readiness status for email sending"
        }
      ]
    },
    {
      "info": {
        "name": "webhooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all webhooks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/webhooks",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter on webhook type"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the results in the ascending/descending order of webhook creation"
              }
            ]
          },
          "docs": "Retrieves all webhooks from your Brevo account with filtering and sorting options.\n\nUse this to:\n- Monitor webhook configurations and event handling\n- List webhooks by type (transactional, marketing, inbound)\n- Review webhook endpoints and authentication\n- Track webhook creation and modification history\n- Audit webhook event subscriptions\n\nKey information returned:\n- Complete webhook details and configuration\n- Event types and channel subscriptions\n- Authentication and security settings\n- Webhoo"
        },
        {
          "info": {
            "name": "Create a webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/webhooks",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new webhook to receive real-time notifications for specified events.\n\nUse this to:\n- Set up event notifications for transactional or marketing emails\n- Configure webhook endpoints for campaign tracking\n- Enable real-time monitoring of email delivery status\n- Subscribe to contact list changes and updates\n- Implement custom event handling and automation\n\nKey information returned:\n- Created webhook ID and configuration\n- Success confirmation and setup details"
        },
        {
          "info": {
            "name": "Get a webhook details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/webhooks/:webhookId",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path",
                "description": "Id of the webhook"
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific webhook configuration.\n\nUse this to:\n- Get complete webhook configuration and settings\n- Check webhook event subscriptions and triggers\n- Review authentication and security settings\n- Verify webhook URL and custom headers\n- Access webhook creation and modification history\n\nKey information returned:\n- Complete webhook details and configuration\n- Event types and channel subscriptions\n- Authentication credentials and methods\n- Custom headers and reque"
        },
        {
          "info": {
            "name": "Update a webhook",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/webhooks/:webhookId",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path",
                "description": "Id of the webhook"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing webhook configuration and event subscriptions.\n\nUse this to:\n- Modify webhook event subscriptions and triggers\n- Update webhook URL and endpoint configuration\n- Change authentication settings and credentials\n- Adjust custom headers and request parameters\n- Enable or disable specific webhook events\n\nKey information returned:\n- Success confirmation of webhook updates"
        },
        {
          "info": {
            "name": "Delete a webhook",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/webhooks/:webhookId",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path",
                "description": "Id of the webhook"
              }
            ]
          },
          "docs": "Permanently deletes a webhook and stops all event notifications.\n\nUse this to:\n- Remove unused or obsolete webhook configurations\n- Clean up webhook endpoints and subscriptions\n- Stop event notifications to specific URLs\n- Maintain organized webhook management\n\nKey information returned:\n- Success confirmation of webhook deletion"
        },
        {
          "info": {
            "name": "Export webhook history",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/webhooks/export",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<Note>\nThis is an enterprise feature. Contact us to activate it for your account.\n</Note>\n\nSubmits a request to export webhook event history as a CSV file. The download link is sent to the `notifyURL` you provide in the request body.\n\nUse this endpoint to:\n- Export webhook event history filtered by date range, event type, or email address\n- Generate reports for compliance, auditing, or performance analysis\n- Track delivery patterns and webhook reliability over time"
        }
      ]
    },
    {
      "info": {
        "name": "account",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get account details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/account",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "Retrieves details of your Brevo account.\n\n**Use this to:**\n- Get account information (email, name, company, address)\n- Check plan details (type, credits, expiration)\n- Get relay information (for transactional emails)\n- Check Marketing Automation status\n- Access organization and user identifiers\n\n**Key information returned:**\n- Complete account details (organization ID, user ID, company information)\n- Address and contact information\n- Plan configurations and credit allocations across different ve"
        },
        {
          "info": {
            "name": "Get user activity logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/organization/activities",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD)\nformat to filter the activity in your account. Maximum time period that\ncan be selected is one month. Additionally, you can retrieve activity\nlogs from the past 12 months from the date of your search."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD)\nformat to filter the activity in your account. Maximum time period that\ncan be selected is one month."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Enter the user's email address to filter their activity in the account."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of documents per page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Index of the first document in the page."
              }
            ]
          },
          "docs": "Retrieves user activity logs from your organization for security monitoring and audit compliance.\n\nUse this to:\n- Monitor user login activities and access patterns\n- Track account modifications and configuration changes\n- Generate security audit reports and compliance documentation\n- Investigate suspicious activities and unauthorized access\n- Monitor team member actions and account usage\n\nKey information returned:\n- Complete user activity details and timestamps\n- User identification (email, IP a"
        }
      ]
    },
    {
      "info": {
        "name": "masterAccount",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of all the sub-accounts of the master account.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/subAccount",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Index of the first sub-account in the page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of sub-accounts to be displayed on each page"
              }
            ]
          },
          "docs": "This endpoint will provide the list all the sub-accounts of the master\naccount."
        },
        {
          "info": {
            "name": "Create a new sub-account under a master account.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/subAccount",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will create a new sub-account under a master account"
        },
        {
          "info": {
            "name": "Get sub-account details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/subAccount/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the sub-account organization"
              }
            ]
          },
          "docs": "This endpoint will provide the details for the specified sub-account company"
        },
        {
          "info": {
            "name": "Delete a sub-account",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/corporate/subAccount/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the sub-account organization to be deleted"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Update sub-account plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/subAccount/:id/plan",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the sub-account organization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will update the sub-account plan. On the Corporate solution\nnew version v2, you can set an unlimited number of credits in your\nsub-organization. Please pass the value “-1\" to set the consumable in\nunlimited mode."
        },
        {
          "info": {
            "name": "Update sub-accounts plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/subAccounts/plan",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will update multiple sub-accounts plan. On the Corporate\nsolution new version v2, you can set an unlimited number of credits in your\nsub-organization. Please pass the value “-1\" to set the consumable in\nunlimited mode."
        },
        {
          "info": {
            "name": "Generate SSO token to access admin account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/ssoToken",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint generates an SSO token to authenticate and access the admin\naccount using the endpoint\nhttps://account-app.brevo.com/account/login/corporate/sso/[token], where\n[token] will be replaced by the actual token."
        },
        {
          "info": {
            "name": "Generate SSO token to access sub-account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/subAccount/ssoToken",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint generates an sso token to authenticate and access a\nsub-account of the master using the account endpoint\nhttps://account-app.brevo.com/account/login/sub-account/sso/[token], where\n[token] will be replaced by the actual token."
        },
        {
          "info": {
            "name": "Get the details of requested master account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/masterAccount",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "This endpoint will provide the details of the master account."
        },
        {
          "info": {
            "name": "Create an API key for a sub-account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/subAccount/key",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will generate an API v3 key for a sub-account"
        },
        {
          "info": {
            "name": "Enable/disable sub-account application(s)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/subAccount/:id/applications/toggle",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the sub-account organization (mandatory)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "API endpoint for the Corporate owner to enable/disable applications on the\nsub-account"
        },
        {
          "info": {
            "name": "Create a new group of sub-accounts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/group",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows to create a group of sub-accounts"
        },
        {
          "info": {
            "name": "List of all IPs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/ip",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "This endpoint allows you to retrieve the list of active IPs on your Admin\naccount"
        },
        {
          "info": {
            "name": "Associate an IP to sub-accounts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/subAccount/ip/associate",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows to associate an IP to sub-accounts"
        },
        {
          "info": {
            "name": "Dissociate an IP to sub-accounts",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/subAccount/ip/dissociate",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows to dissociate an IP from sub-accounts"
        },
        {
          "info": {
            "name": "GET a group details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/group/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the group of sub-organization"
              }
            ]
          },
          "docs": "This endpoint allows you to retrieve a specific group’s information such as\nthe list of sub-organizations and the user associated with the group."
        },
        {
          "info": {
            "name": "Update a group of sub-accounts",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/group/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the group"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows to update a group of sub-accounts"
        },
        {
          "info": {
            "name": "Delete a group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/corporate/group/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the group"
              }
            ]
          },
          "docs": "This endpoint allows you to delete a group of sub-organizations. When a\ngroup is deleted, the sub-organizations are no longer part of this group.\nThe users associated with the group are no longer associated with the group\nonce deleted."
        },
        {
          "info": {
            "name": "Delete sub-account from group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/group/unlink/:groupId/subAccounts",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Group id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to remove a sub-organization from a group."
        },
        {
          "info": {
            "name": "Send invitation to an admin user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/corporate/user/invitation/send",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`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  "
        },
        {
          "info": {
            "name": "Resend / cancel admin user invitation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/user/invitation/:action/:email",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "path",
                "description": "Action to be performed (cancel / resend)"
              },
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email address of the recipient"
              }
            ]
          },
          "docs": "This endpoint will allow the user to:\n- Resend an admin user invitation\n- Cancel an admin user invitation\n"
        },
        {
          "info": {
            "name": "Revoke an admin user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/corporate/user/revoke/:email",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email of the invited user"
              }
            ]
          },
          "docs": "This endpoint allows to revoke/remove an invited member of your Admin\naccount"
        },
        {
          "info": {
            "name": "Get the list of all admin users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/invited/users",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "User type (active | pending). This is required if offset is provided for\nlimited result."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Page number for the result set. This is optional, default value will be\nthe 1st page."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to be displayed on each page. This is optional, the\ndefault limit is 20, but max allowed limit is 100."
              }
            ]
          },
          "docs": "This endpoint allows you to list all Admin users of your Admin account. You\ncan filter users by type (active or pending) and paginate results using\noffset and limit."
        },
        {
          "info": {
            "name": "Check admin user permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/user/:email/permissions",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email of the invited user."
              }
            ]
          },
          "docs": "This endpoint will provide the list of admin user permissions"
        },
        {
          "info": {
            "name": "Change admin user permissions",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/corporate/user/:email/permissions",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email address of Admin user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will allow you to change the permissions of Admin users of\nyour Admin account"
        },
        {
          "info": {
            "name": "Get the list of groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/corporate/groups",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "This endpoint allows you to list all groups created on your Admin account."
        }
      ]
    },
    {
      "info": {
        "name": "user",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of all your users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/organization/invited/users",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Check user permission",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/organization/user/:email/permissions",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email of the invited user."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Revoke user permission",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/organization/user/invitation/revoke/:email",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email of the invited user."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Resend / Cancel invitation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/organization/user/invitation/:action/:email",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "path",
                "description": "action"
              },
              {
                "name": "email",
                "value": "",
                "type": "path",
                "description": "Email of the invited user."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Send invitation to user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/organization/user/invitation/send",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`Feature` - A Feature represents a specific functionality like Email\ncampaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user,\ndetermine which feature you want to manage access to. You must specify the\nfeature accurately to avoid errors. `Permission` - A Permission defines the\nlevel of access or control a user has over a specific feature. While\ninviting user, decide on the permission level required for the selected\nfeature. Make sure the chosen permission is related to the selec"
        },
        {
          "info": {
            "name": "Update permission for a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/organization/user/update/permissions",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`Feature` - A Feature represents a specific functionality like Email\ncampaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user,\ndetermine which feature you want to manage access to. You must specify the\nfeature accurately to avoid errors. `Permission` - A Permission defines the\nlevel of access or control a user has over a specific feature. While\ninviting user, decide on the permission level required for the selected\nfeature. Make sure the chosen permission is related to the selec"
        }
      ]
    },
    {
      "info": {
        "name": "process",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get background processes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/processes",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number limitation for the result returned"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Beginning point in the list to retrieve from."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the results in the ascending/descending order of record creation.\nDefault order is **descending** if `sort` is not passed"
              }
            ]
          },
          "docs": "Retrieves a list of background processes from your Brevo account with filtering and pagination.\n\n**Use this to:**\n- Monitor background process activity and status\n- Track long-running operations and tasks\n- Find process IDs for detailed status checking\n- Review process history and performance\n- Identify failed or stuck processes for troubleshooting\n\n**Key information returned:**\n- Process details (ID, name, status)\n- Export download URLs for completed export processes\n- Import details with CSV r"
        },
        {
          "info": {
            "name": "Get process details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/processes/:processId",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "processId",
                "value": "",
                "type": "path",
                "description": "Id of the process"
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific background process.\n\n**Use this to:**\n- Get detailed status of a specific process\n- Monitor process progress and completion\n- Download results from completed export processes\n- Check error details for failed processes\n- Track process execution times\n\n**Key information returned:**\n- Complete process details (ID, name, status)\n- Download URLs for completed export processes\n- Import details with CSV report URLs for completed import processes\n\n**Import"
        }
      ]
    },
    {
      "info": {
        "name": "externalFeeds",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all external feeds",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/feeds",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Can be used to filter records by search keyword on feed name"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which\nyou want to fetch the list. Can be maximum 30 days older than current\ndate."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which\nyou want to fetch the list. Maximum time period that can be selected is\none month."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the results in the ascending/descending order of record creation.\nDefault order is **descending** if `sort` is not passed."
              },
              {
                "name": "authType",
                "value": "",
                "type": "query",
                "description": "Filter the records by `authType` of the feed."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of documents returned per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Index of the first document on the page."
              }
            ]
          },
          "docs": "Retrieves all external feeds from your Brevo account with filtering and pagination.\n\n**Use this to:**\n- Get an overview of all external data feeds\n- Find feeds by name using search functionality\n- Filter feeds by creation date range\n- Browse feeds by authentication type\n- Monitor feed library organization and usage\n\n**Key information returned:**\n- Feed details (UUID, name, URL, authentication type)\n- Feed configuration and settings\n- Creation and modification timestamps\n- Feed status and error i"
        },
        {
          "info": {
            "name": "Create external feed",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/feeds",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new external feed for dynamic content in email campaigns.\n\n**Use this to:**\n- Set up external data sources for dynamic content\n- Configure authentication for protected feeds\n- Enable real-time content updates in campaigns\n- Establish connections to product catalogs, blogs, or APIs\n\n**Key information returned:**\n- Created feed UUID for reference in campaigns\n- Success confirmation\n\n**Important considerations:**\n- Feed URL must be accessible from Brevo infrastructure\n- Authentication cre"
        },
        {
          "info": {
            "name": "Get external feed details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/feeds/:uuid",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the feed to fetch"
              }
            ]
          },
          "docs": "Retrieves details of a specific external feed by its UUID.\n\n**Use this to:**\n- Get complete configuration of an external feed\n- Check feed authentication settings\n- Review feed personalization options\n- Verify feed URL and parameters\n- Monitor feed modification history\n\n**Key information returned:**\n- Complete feed configuration and settings\n- Authentication credentials and headers\n- Personalization and fallback settings\n- Creation and modification timestamps\n- Cache and retry configurations\n\n**"
        },
        {
          "info": {
            "name": "Update external feed",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/feeds/:uuid",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the feed to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates configuration of an existing external feed.\n\n**Use this to:**\n- Update feed URLs when data sources change\n- Modify authentication credentials\n- Change cache and retry settings\n- Update custom headers\n- Rename feeds for better organization\n\n**Key information returned:**\n- Success confirmation message\n\n**Important considerations:**\n- Only provided fields will be updated\n- Feed UUID must exist in your account\n- Authentication changes require verification\n- URL changes should be tested befor"
        },
        {
          "info": {
            "name": "Delete external feed",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/feeds/:uuid",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the feed to delete"
              }
            ]
          },
          "docs": "Deletes an external feed from your Brevo account.\n\n**Use this to:**\n- Remove external feeds that are no longer needed\n- Clean up unused data sources\n- Remove test or outdated feeds\n- Maintain organized feed library\n\n**Key information returned:**\n- Success confirmation message\n\n**Important considerations:**\n- This action is PERMANENT and cannot be undone\n- Feed configuration and history will be lost\n- Check if feed is used in active campaigns before deletion\n- Remove feed references from email te"
        }
      ]
    }
  ],
  "bundled": true
}