{"openapi":"3.1.0","info":{"title":"Accounts and Settings","version":"1.0.0"},"paths":{"/senders":{"get":{"operationId":"getSenders","summary":"Get email senders","description":"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- Associated IP addresses and domains (for dedicated IP accounts)\n- Sender configuration settings\n\n**Important considerations:**\n- Standard accounts show empty IP arrays, dedicated IP accounts show IP assignments\n- Filtering by IP only available for accounts with dedicated IPs\n- Domain filtering helps organize senders by business units or brands\n- Sender status indicates if sender is active and ready for campaign use\n- Email verification required before sender can be used in campaigns\n","tags":["senders"],"parameters":[{"name":"ip","in":"query","description":"Filter your senders for a specific ip. **Available for dedicated IP usage only**\n","required":false,"schema":{"type":"string"}},{"name":"domain","in":"query","description":"Filter your senders for a specific domain","required":false,"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 senders retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Senders_getSenders_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSendersRequestBadRequestError"}}}}}},"post":{"operationId":"createSender","summary":"Create email sender","description":"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 deliverability\n- Dedicated IP accounts require IP association during creation\n- IP weights must sum to 100 when specified\n- Sender must be verified before use in campaigns\n","tags":["senders"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Sender created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Senders_createSender_Response_201"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSenderRequestBadRequestError"}}}}},"requestBody":{"description":"sender's configuration","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"From email to use for the sender. A verification email will be\nsent to this address."},"ips":{"type":"array","items":{"$ref":"#/components/schemas/SendersPostRequestBodyContentApplicationJsonSchemaIpsItems"},"description":"**Mandatory in case of dedicated IP**. IPs to associate to the\nsender. Not required for standard accounts."},"name":{"type":"string","description":"From Name to use for the sender"}},"required":["email","name"]}}}}}},"/senders/{senderId}":{"put":{"operationId":"updateSender","summary":"Update a sender","description":"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","tags":["senders"],"parameters":[{"name":"senderId","in":"path","description":"Id of the sender","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Sender updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSenderRequestBadRequestError"}}}},"404":{"description":"Sender ID not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"sender's configuration to update","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"From Email to update the sender"},"ips":{"type":"array","items":{"$ref":"#/components/schemas/SendersSenderIdPutRequestBodyContentApplicationJsonSchemaIpsItems"},"description":"**Only in case of dedicated IP**. IPs to associate to the\nsender. If passed, will replace all the existing IPs. Not required for standard accounts."},"name":{"type":"string","description":"From Name to update the sender"}}}}}}},"delete":{"operationId":"deleteSender","summary":"Delete a sender","description":"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","tags":["senders"],"parameters":[{"name":"senderId","in":"path","description":"Id of the sender","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Sender deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSenderRequestBadRequestError"}}}},"404":{"description":"Sender ID not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/senders/{senderId}/validate":{"put":{"operationId":"validateSenderByOTP","summary":"Validate a sender using OTP","description":"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","tags":["senders"],"parameters":[{"name":"senderId","in":"path","description":"Id of the sender","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Sender verified successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateSenderByOTPRequestBadRequestError"}}}},"404":{"description":"Sender ID not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"OTP verification code","content":{"application/json":{"schema":{"type":"object","properties":{"otp":{"type":"integer","description":"6 digit OTP received on email"}},"required":["otp"]}}}}}},"/senders/ips":{"get":{"operationId":"getIps","summary":"Get all the dedicated IPs for your account","description":"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","tags":["senders"],"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 dedicated IPs retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Senders_getIps_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIpsRequestBadRequestError"}}}}}}},"/senders/{senderId}/ips":{"get":{"operationId":"getIpsFromSender","summary":"Get all the dedicated IPs for a specific sender","description":"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","tags":["senders"],"parameters":[{"name":"senderId","in":"path","description":"Id of the sender","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of dedicated IPs retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Senders_getIpsFromSender_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIpsFromSenderRequestBadRequestError"}}}},"404":{"description":"Sender ID not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/senders/domains":{"get":{"operationId":"getDomains","summary":"Get the list of all sender domains","description":"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 for large domain lists","tags":["domains"],"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 domains retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domains_getDomains_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainsRequestBadRequestError"}}}}}},"post":{"operationId":"createDomain","summary":"Create a new sender domain","description":"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","tags":["domains"],"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":"Domain created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domains_createDomain_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainRequestBadRequestError"}}}}},"requestBody":{"description":"Domain configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"hostname","description":"Domain name to be added"}},"required":["name"]}}}}}},"/senders/domains/{domainName}":{"delete":{"operationId":"deleteDomain","summary":"Delete a sender domain","description":"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","tags":["domains"],"parameters":[{"name":"domainName","in":"path","description":"Domain name","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":"Domain deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domains_deleteDomain_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDomainRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDomainRequestNotFoundError"}}}}}},"get":{"operationId":"getDomainConfiguration","summary":"Get a sender domain configuration","description":"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","tags":["domains"],"parameters":[{"name":"domainName","in":"path","description":"Domain name","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":"Domain configuration retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domains_getDomainConfiguration_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainConfigurationRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainConfigurationRequestNotFoundError"}}}}}}},"/senders/domains/{domainName}/authenticate":{"put":{"operationId":"authenticateDomain","summary":"Authenticate a sender domain","description":"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","tags":["domains"],"parameters":[{"name":"domainName","in":"path","description":"Domain name","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":"Domain authenticated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domains_authenticateDomain_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticateDomainRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticateDomainRequestNotFoundError"}}}}}}},"/webhooks":{"get":{"operationId":"getWebhooks","summary":"Get all webhooks","description":"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- Webhook URLs and custom headers\n- Creation and modification timestamps","tags":["webhooks"],"parameters":[{"name":"type","in":"query","description":"Filter on webhook type","required":false,"schema":{"$ref":"#/components/schemas/WebhooksGetParametersType","default":"transactional"}},{"name":"sort","in":"query","description":"Sort the results in the ascending/descending order of webhook creation","required":false,"schema":{"$ref":"#/components/schemas/WebhooksGetParametersSort","default":"desc"}},{"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":"Webhooks informations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks_getWebhooks_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhooksRequestBadRequestError"}}}}}},"post":{"operationId":"createWebhook","summary":"Create a webhook","description":"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","tags":["webhooks"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks_createWebhook_Response_201"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequestBadRequestError"}}}}},"requestBody":{"description":"Values to create a webhook","content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"$ref":"#/components/schemas/WebhooksPostRequestBodyContentApplicationJsonSchemaAuth","description":"Add authentication on webhook url"},"batched":{"type":"boolean","description":"To send batched webhooks"},"channel":{"$ref":"#/components/schemas/WebhooksPostRequestBodyContentApplicationJsonSchemaChannel","default":"email","description":"Channel of the webhook"},"description":{"type":"string","description":"Description of the webhook"},"domain":{"type":"string","description":"Inbound domain of webhook, required in case of event type\n`inbound`"},"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhooksPostRequestBodyContentApplicationJsonSchemaEventsItems"},"description":"Events triggering the webhook. Required for transactional and\nmarketing types, optional for inbound type (defaults to\n`inboundEmailProcessed`). Possible values for **Transactional**\ntype webhook: `sent` OR `request`, `delivered`, `hardBounce`,\n`softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`,\n`opened`, `uniqueOpened` and `unsubscribed`. Possible values for\n**Marketing** type webhook: `spam`, `opened`, `click`,\n`hardBounce`, `softBounce`, `unsubscribed`, `listAddition`,\n`delivered`, `contactUpdated` & `contactDeleted`. Possible values\nfor **Inbound** type webhook: `inboundEmailProcessed`."},"headers":{"type":"array","items":{"$ref":"#/components/schemas/WebhooksPostRequestBodyContentApplicationJsonSchemaHeadersItems"},"description":"Custom headers to be send with webhooks"},"type":{"$ref":"#/components/schemas/WebhooksPostRequestBodyContentApplicationJsonSchemaType","default":"transactional","description":"Type of the webhook"},"url":{"type":"string","format":"url","description":"URL of the webhook"}},"required":["url"]}}}}}},"/webhooks/{webhookId}":{"get":{"operationId":"getWebhook","summary":"Get a webhook details","description":"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 request settings\n- Webhook status and activity information","tags":["webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"Id of the webhook","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook informations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getWebhook"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookRequestNotFoundError"}}}}}},"put":{"operationId":"updateWebhook","summary":"Update a webhook","description":"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","tags":["webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"Id of the webhook","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Webhook updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequestNotFoundError"}}}}},"requestBody":{"description":"Values to update a webhook","content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"$ref":"#/components/schemas/WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaAuth","description":"Add authentication on webhook url"},"batched":{"type":"boolean","description":"To send batched webhooks"},"description":{"type":"string","description":"Description of the webhook"},"domain":{"type":"string","description":"Inbound domain of webhook, used in case of event type `inbound`"},"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaEventsItems"},"description":"- Events triggering the webhook. Possible values for\n**Transactional** type webhook: #### `sent` OR `request`,\n`delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,\n`invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and\n`unsubscribed` - Possible values for **Marketing** type webhook:\n#### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,\n`unsubscribed`, `listAddition` & `delivered` - Possible values\nfor **Inbound** type webhook: #### `inboundEmailProcessed`\n#### `reply`"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaHeadersItems"},"description":"Custom headers to be send with webhooks"},"url":{"type":"string","format":"url","description":"URL of the webhook"}}}}}}},"delete":{"operationId":"deleteWebhook","summary":"Delete a webhook","description":"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","tags":["webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"Id of the webhook","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Webhook deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWebhookRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWebhookRequestNotFoundError"}}}}}}},"/webhooks/export":{"post":{"operationId":"exportWebhooksHistory","summary":"Export webhook history","description":"<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","tags":["webhooks"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"process id created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks_exportWebhooksHistory_Response_202"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportWebhooksHistoryRequestBadRequestError"}}}}},"requestBody":{"description":"Values to submit for webhooks history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks_exportWebhooksHistory_Request"}}}}}},"/account":{"get":{"operationId":"getAccount","summary":"Get account details","description":"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 verticals\n- Marketing Automation settings and tracker key (when enabled)\n- SMTP relay configuration for transactional emails\n- Enterprise features availability status\n\n**Important considerations:**\n- Provides comprehensive account overview for billing and configuration management\n- Essential for understanding current plan limitations and feature availability\n- Marketing Automation key is only returned when Marketing Automation is enabled on the account\n- Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available)\n- Relay configuration crucial for transactional email setup and deliverability\n- Enterprise status determines access to advanced features and sub-account management\n","tags":["account"],"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":"Account information retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account_getAccount_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountRequestBadRequestError"}}}}}}},"/organization/activities":{"get":{"operationId":"getAccountActivity","summary":"Get user activity logs","description":"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 address, browser)\n- Action types and activity descriptions\n- Security-relevant events and access logs\n- Historical activity data for audit trails\n\nNote: Requires Enterprise plan for access to organization activity logs.","tags":["account"],"parameters":[{"name":"startDate","in":"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.","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"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.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Enter the user's email address to filter their activity in the account.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of documents per page","required":false,"schema":{"type":"integer","format":"int64","default":10}},{"name":"offset","in":"query","description":"Index of the first document in the page.","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"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 user activity logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account_getAccountActivity_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountActivityRequestBadRequestError"}}}}}}},"/corporate/subAccount":{"get":{"operationId":"getTheListOfAllTheSubAccountsOfTheMasterAccount","summary":"Get the list of all the sub-accounts of the master account.","description":"This endpoint will provide the list all the sub-accounts of the master\naccount.","tags":["masterAccount"],"parameters":[{"name":"offset","in":"query","description":"Index of the first sub-account in the page","required":true,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Number of sub-accounts to be displayed on each page","required":true,"schema":{"type":"integer"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sub-accounts list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_getTheListOfAllTheSubAccountsOfTheMasterAccount_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTheListOfAllTheSubAccountsOfTheMasterAccountRequestBadRequestError"}}}}}},"post":{"operationId":"createANewSubAccountUnderAMasterAccount","summary":"Create a new sub-account under a master account.","description":"This endpoint will create a new sub-account under a master account","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created sub-account ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_createANewSubAccountUnderAMasterAccount_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"Request body with sub-account organization name","content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"type":"string","description":"Set the name of the sub-account company"},"email":{"type":"string","description":"Email address for the organization"},"groupIds":{"type":"array","items":{"type":"string"},"description":"Set the group(s) for the sub-account"},"language":{"$ref":"#/components/schemas/CorporateSubAccountPostRequestBodyContentApplicationJsonSchemaLanguage","description":"Set the language of the sub-account"},"timezone":{"type":"string","description":"Set the timezone of the sub-account"}},"required":["companyName","email"]}}}}}},"/corporate/subAccount/{id}":{"get":{"operationId":"getSubAccountDetails","summary":"Get sub-account details","description":"This endpoint will provide the details for the specified sub-account company","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the sub-account organization","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sub-account organization details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_getSubAccountDetails_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSubAccountDetailsRequestBadRequestError"}}}}}},"delete":{"operationId":"deleteASubAccount","summary":"Delete a sub-account","description":"Permanently deletes a sub-account from the corporate master account. Once deleted, all data associated with the sub-account organization is removed and cannot be recovered, so ensure the sub-account is no longer needed before proceeding.","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the sub-account organization to be deleted","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned when sub-account is deleted succesfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"sub-account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/corporate/subAccount/{id}/plan":{"put":{"operationId":"updateSubAccountPlan","summary":"Update sub-account plan","description":"This endpoint will update the sub-account plan. On the Corporate solution\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.","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the sub-account organization","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Sub account plan updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubAccountPlanRequestBadRequestError"}}}},"403":{"description":"Current account is not a master account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"Values to update a sub-account plan","content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"$ref":"#/components/schemas/CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaCredits","description":"Credit details to update"},"features":{"$ref":"#/components/schemas/CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaFeatures","description":"Features details to update"}}}}}}}},"/corporate/subAccounts/plan":{"put":{"operationId":"updateSubAccountsPlan","summary":"Update sub-accounts plan","description":"This endpoint will update multiple sub-accounts plan. On the Corporate\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.","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Request accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_updateSubAccountsPlan_Response_202"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubAccountsPlanRequestBadRequestError"}}}},"403":{"description":"Current account is not a master account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"Values to update sub-accounts plan","content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"$ref":"#/components/schemas/CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaCredits","description":"Credit details to update"},"features":{"$ref":"#/components/schemas/CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaFeatures","description":"Features details to update"},"subAccountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"List of sub-account ids"}}}}}}}},"/corporate/ssoToken":{"post":{"operationId":"generateSsoTokenToAccessAdminAccount","summary":"Generate SSO token to access admin account","description":"This endpoint generates an SSO token to authenticate and access the admin\naccount using the endpoint\nhttps://account-app.brevo.com/account/login/corporate/sso/[token], where\n[token] will be replaced by the actual token.","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Session token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSsoToken"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"Current account is not an admin account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email of admin account"}},"required":["email"]}}}}}},"/corporate/subAccount/ssoToken":{"post":{"operationId":"generateSsoTokenToAccessSubAccount","summary":"Generate SSO token to access sub-account","description":"This endpoint generates an sso token to authenticate and access a\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.","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Session token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSsoToken"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"Current account is not a master account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email of sub-account organization"},"id":{"type":"integer","format":"int64","description":"Id of the sub-account organization"},"target":{"$ref":"#/components/schemas/CorporateSubAccountSsoTokenPostRequestBodyContentApplicationJsonSchemaTarget","description":"**Set target after login success** * **automation** - Redirect\nto Automation after login * **email_campaign** - Redirect to\nEmail Campaign after login * **contacts** - Redirect to Contacts\nafter login * **landing_pages** - Redirect to Landing Pages\nafter login * **email_transactional** - Redirect to Email\nTransactional after login * **senders** - Redirect to Senders\nafter login * **sms_campaign** - Redirect to Sms Campaign after\nlogin * **sms_transactional** - Redirect to Sms Transactional\nafter login"},"url":{"type":"string","description":"Set the full target URL after login success. The user will land\ndirectly on this target URL after login"}},"required":["id"]}}}}}},"/corporate/masterAccount":{"get":{"operationId":"getTheDetailsOfRequestedMasterAccount","summary":"Get the details of requested master account","description":"This endpoint will provide the details of the master account.","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Master account details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_getTheDetailsOfRequestedMasterAccount_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTheDetailsOfRequestedMasterAccountRequestBadRequestError"}}}}}}},"/corporate/subAccount/key":{"post":{"operationId":"createAnApiKeyForASubAccount","summary":"Create an API key for a sub-account","description":"This endpoint will generate an API v3 key for a sub-account","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_createAnApiKeyForASubAccount_Response_201"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Id of the sub-account organization"},"name":{"type":"string","description":"Name of the API key"}},"required":["id","name"]}}}}}},"/corporate/subAccount/{id}/applications/toggle":{"put":{"operationId":"enableDisableSubAccountApplicationS","summary":"Enable/disable sub-account application(s)","description":"API endpoint for the Corporate owner to enable/disable applications on the\nsub-account","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the sub-account organization (mandatory)","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Sub-account application(s) enabled/disabled","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableDisableSubAccountApplicationSRequestBadRequestError"}}}},"403":{"description":"Current account is not a master account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"List of applications to activate or deactivate on a sub-account","content":{"application/json":{"schema":{"type":"object","properties":{"automation":{"type":"boolean","description":"Set this field to enable or disable Automation on the\nsub-account"},"conversations":{"type":"boolean","description":"Set this field to enable or disable Conversations on the\nsub-account"},"crm":{"type":"boolean","description":"Set this field to enable or disable Sales CRM on the sub-account"},"email-campaigns":{"type":"boolean","description":"Set this field to enable or disable Email Campaigns on the\nsub-account"},"facebook-ads":{"type":"boolean","description":"Set this field to enable or disable Facebook ads on the\nsub-account"},"inbox":{"type":"boolean","description":"Set this field to enable or disable Inbox on the sub-account /\nNot applicable on ENTv2"},"landing-pages":{"type":"boolean","description":"Set this field to enable or disable Landing pages on the\nsub-account"},"meetings":{"type":"boolean","description":"Set this field to enable or disable Meetings on the sub-account"},"sms-campaigns":{"type":"boolean","description":"Set this field to enable or disable SMS Marketing on the\nsub-account"},"transactional-emails":{"type":"boolean","description":"Set this field to enable or disable Transactional Email on the\nsub-account"},"transactional-sms":{"type":"boolean","description":"Set this field to enable or disable Transactional SMS on the\nsub-account"},"web-push":{"type":"boolean","description":"Set this field to enable or disable Web Push on the sub-account"},"whatsapp":{"type":"boolean","description":"Set this field to enable or disable Whatsapp campaigns on the\nsub-account"}}}}}}}},"/corporate/group":{"post":{"operationId":"createANewGroupOfSubAccounts","summary":"Create a new group of sub-accounts","description":"This endpoint allows to create a group of sub-accounts","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Group ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_createANewGroupOfSubAccounts_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"groupName":{"type":"string","description":"The name of the group of sub-accounts"},"subAccountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Pass the list of sub-account Ids to be included in the group"}},"required":["groupName"]}}}}}},"/corporate/ip":{"get":{"operationId":"listOfAllIPs","summary":"List of all IPs","description":"This endpoint allows you to retrieve the list of active IPs on your Admin\naccount","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of all IPs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CorporateIpGetResponsesContentApplicationJsonSchemaItems"}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/corporate/subAccount/ip/associate":{"post":{"operationId":"associateAnIpToSubAccounts","summary":"Associate an IP to sub-accounts","description":"This endpoint allows to associate an IP to sub-accounts","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"IP has been associated with sub-accounts successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_associateAnIpToSubAccounts_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Pass the list of sub-account Ids to be associated with the IP\naddress"},"ip":{"type":"string","description":"IP address"}},"required":["ids","ip"]}}}}}},"/corporate/subAccount/ip/dissociate":{"put":{"operationId":"dissociateAnIpToSubAccounts","summary":"Dissociate an IP to sub-accounts","description":"This endpoint allows to dissociate an IP from sub-accounts","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"IP has been dissociated from sub-accounts successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Pass the list of sub-account Ids to be dissociated from the IP\naddress"},"ip":{"type":"string","description":"IP address"}},"required":["ids","ip"]}}}}}},"/corporate/group/{id}":{"get":{"operationId":"getAGroupDetails","summary":"GET a group details","description":"This endpoint allows you to retrieve a specific group’s information such as\nthe list of sub-organizations and the user associated with the group.","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the group of sub-organization","required":true,"schema":{"type":"string"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_getAGroupDetails_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"put":{"operationId":"updateAGroupOfSubAccounts","summary":"Update a group of sub-accounts","description":"This endpoint allows to update a group of sub-accounts","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the group","required":true,"schema":{"type":"string"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group details updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"Group details to be updated.","content":{"application/json":{"schema":{"type":"object","properties":{"groupName":{"type":"string","description":"The name of the group of sub-accounts"},"subAccountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Pass the list of sub-account Ids to be included in the group"}}}}}}},"delete":{"operationId":"deleteAGroup","summary":"Delete a group","description":"This endpoint allows you to delete a group of sub-organizations. When a\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.","tags":["masterAccount"],"parameters":[{"name":"id","in":"path","description":"Id of the group","required":true,"schema":{"type":"string"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/corporate/group/unlink/{groupId}/subAccounts":{"put":{"operationId":"deleteSubAccountFromGroup","summary":"Delete sub-account from group","description":"This endpoint allows you to remove a sub-organization from a group.","tags":["masterAccount"],"parameters":[{"name":"groupId","in":"path","description":"Group id","required":true,"schema":{"type":"string"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"SubAccounts removed from the group","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"List of sub-account ids","content":{"application/json":{"schema":{"type":"object","properties":{"subAccountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"List of sub-account ids"}},"required":["subAccountIds"]}}}}}},"/corporate/user/invitation/send":{"post":{"operationId":"inviteAdminUser","summary":"Send invitation to an admin user","description":"`This endpoint allows you to invite a member to manage the Admin account\nFeatures and their respective permissions are as below: - `my_plan`:\n  - \"all\"\n- `api`:\n  - \"none\"\n- `user_management`:\n  - \"all\"\n- `app_management` | Not available in ENTv2:\n  - \"all\"\n- `sub_organization_groups`\n  - \"create\"\n  - \"edit_delete\"\n- `create_sub_organizations`\n  - \"all\"\n- `manage_sub_organizations`\n  - \"all\"\n- `analytics`\n  - \"download_data\"\n  - \"create_alerts\"\n  - \"my_looks\"\n  - \"explore_create\"\n- `security`\n  - \"all\"\n**Note**: - If `all_features_access: false` then only privileges are\nrequired otherwise if `true` then it's assumed that all permissions will be\nthere for the invited admin user.","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Invitation ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_inviteAdminUser_Response_201"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteAdminUserRequestBadRequestError"}}}}},"requestBody":{"description":"Payload to send an invitation","content":{"application/json":{"schema":{"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"},"groupIds":{"type":"array","items":{"type":"string"},"description":"Ids of Group"},"privileges":{"type":"array","items":{"$ref":"#/components/schemas/CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItems"}}},"required":["all_features_access","email","privileges"]}}}}}},"/corporate/user/invitation/{action}/{email}":{"put":{"operationId":"resendCancelAdminUserInvitation","summary":"Resend / cancel admin user invitation","description":"This endpoint will allow the user to:\n- Resend an admin user invitation\n- Cancel an admin user invitation\n","tags":["masterAccount"],"parameters":[{"name":"action","in":"path","description":"Action to be performed (cancel / resend)","required":true,"schema":{"$ref":"#/components/schemas/CorporateUserInvitationActionEmailPutParametersAction"}},{"name":"email","in":"path","description":"Email address of the recipient","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":"Response of the action performed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_resendCancelAdminUserInvitation_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/corporate/user/revoke/{email}":{"delete":{"operationId":"revokeAnAdminUser","summary":"Revoke an admin user","description":"This endpoint allows to revoke/remove an invited member of your Admin\naccount","tags":["masterAccount"],"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":{"204":{"description":"User revoked","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/corporate/invited/users":{"get":{"operationId":"getCorporateInvitedUsersList","summary":"Get the list of all admin users","description":"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.","tags":["masterAccount"],"parameters":[{"name":"type","in":"query","description":"User type (active | pending). This is required if offset is provided for\nlimited result.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Page number for the result set. This is optional, default value will be\nthe 1st page.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"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.","required":false,"schema":{"type":"integer"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of all admin users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_getCorporateInvitedUsersList_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/corporate/user/{email}/permissions":{"get":{"operationId":"getCorporateUserPermission","summary":"Check admin user permissions","description":"This endpoint will provide the list of admin user permissions","tags":["masterAccount"],"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 user's permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Master account_getCorporateUserPermission_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCorporateUserPermissionRequestBadRequestError"}}}}}},"put":{"operationId":"changeAdminUserPermissions","summary":"Change admin user permissions","description":"This endpoint will allow you to change the permissions of Admin users of\nyour Admin account","tags":["masterAccount"],"parameters":[{"name":"email","in":"path","description":"Email address of Admin 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":{"204":{"description":"User permissions has been modified","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"description":"Values to update an admin user permissions","content":{"application/json":{"schema":{"type":"object","properties":{"all_features_access":{"type":"boolean","description":"All access to the features"},"privileges":{"type":"array","items":{"$ref":"#/components/schemas/CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItems"}}},"required":["all_features_access","privileges"]}}}}}},"/corporate/groups":{"get":{"operationId":"getSubAccountGroups","summary":"Get the list of groups","description":"This endpoint allows you to list all groups created on your Admin account.","tags":["masterAccount"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of all the sub-account groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CorporateGroupsGetResponsesContentApplicationJsonSchemaItems"}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/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\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 selected feature.\nFeatures and their respective permissions are as below: - `email_campaigns`:\n  - \"create_edit_delete\"\n  - \"send_schedule_suspend\"\n- `sms_campaigns`:\n  - \"create_edit_delete\"\n  - \"send_schedule_suspend\"\n- `contacts`:\n  - \"view\"\n  - \"create_edit_delete\"\n  - \"import\"\n  - \"export\"\n  - \"list_and_attributes\"\n  - \"forms\"\n- `templates`:\n  - \"create_edit_delete\"\n  - \"activate_deactivate\"\n- `workflows`:\n  - \"create_edit_delete\"\n  - \"activate_deactivate_pause\"\n  - \"settings\"\n- `landing_pages`:\n  - \"all\"\n- `transactional_emails`:\n  - \"settings\"\n  - \"logs\"\n- `smtp_api`:\n  - \"smtp\"\n  - \"api_keys\"\n  - \"authorized_ips\"\n- `user_management`:\n  - \"all\"\n- `sales_platform`:\n  - \"create_edit_deals\"\n  - \"delete_deals\"\n  - \"manage_others_deals_tasks\"\n  - \"reports\"\n  - \"settings\"\n- `phone`:\n  - \"all\"\n- `conversations`:\n  - \"access\"\n  - \"assign\"\n  - \"configure\"\n- `senders_domains_dedicated_ips`:\n  - \"senders_management\"\n  - \"domains_management\"\n  - \"dedicated_ips_management\"\n- `push_notifications`:\n  - \"view\"\n  - \"create_edit_delete\"\n  - \"send\"\n  - \"settings\"\n- `companies`:\n  - \"manage_owned_companies\"\n  - \"manage_other_companies\"\n  - \"settings\"\n**Note**: - If `all_features_access: false` then only privileges are\nrequired otherwise if `true` then it's assumed that all permissions will be\nthere for the invited user. - The availability of feature and its permission\ndepends on your current plan. Please select the features and permissions\naccordingly.","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\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 selected feature.\nFeatures and their respective permissions are as below: - `email_campaigns`:\n  - \"create_edit_delete\"\n  - \"send_schedule_suspend\"\n- `sms_campaigns`:\n  - \"create_edit_delete\"\n  - \"send_schedule_suspend\"\n- `contacts`:\n  - \"view\"\n  - \"create_edit_delete\"\n  - \"import\"\n  - \"export\"\n  - \"list_and_attributes\"\n  - \"forms\"\n- `templates`:\n  - \"create_edit_delete\"\n  - \"activate_deactivate\"\n- `workflows`:\n  - \"create_edit_delete\"\n  - \"activate_deactivate_pause\"\n  - \"settings\"\n- `landing_pages`:\n  - \"all\"\n- `transactional_emails`:\n  - \"settings\"\n  - \"logs\"\n- `smtp_api`:\n  - \"smtp\"\n  - \"api_keys\"\n  - \"authorized_ips\"\n- `user_management`:\n  - \"all\"\n- `sales_platform`:\n  - \"create_edit_deals\"\n  - \"delete_deals\"\n  - \"manage_others_deals_tasks\"\n  - \"reports\"\n  - \"settings\"\n- `phone`:\n  - \"all\"\n- `conversations`:\n  - \"access\"\n  - \"assign\"\n  - \"configure\"\n- `senders_domains_dedicated_ips`:\n  - \"senders_management\"\n  - \"domains_management\"\n  - \"dedicated_ips_management\"\n- `push_notifications`:\n  - \"view\"\n  - \"create_edit_delete\"\n  - \"send\"\n  - \"settings\"\n- `companies`:\n  - \"manage_owned_companies\"\n  - \"manage_other_companies\"\n  - \"settings\"\n**Note**: - The privileges array remains the same as in the send invitation;\nthe user simply needs to provide the permissions that need to be updated. -\nThe availability of feature and its permission depends on your current plan.\nPlease 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"}}}}}},"/processes":{"get":{"operationId":"getProcesses","summary":"Get background processes","description":"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 report URLs for completed import processes\n- Total count of processes for pagination\n\n**Important considerations:**\n- Background processes handle long-running operations like imports and exports\n- Process status indicates current state (queued, processing, completed)\n- Export processes provide download URLs when completed\n- Import processes provide CSV report URLs with details about problematic records\n- Use pagination for accounts with many historical processes\n- Sort options available for creation order (ascending or descending)\n- Default limit is 10 results per page, maximum is 50\n","tags":["process"],"parameters":[{"name":"limit","in":"query","description":"Number limitation for the result returned","required":false,"schema":{"type":"integer","format":"int64","default":10}},{"name":"offset","in":"query","description":"Beginning point in the list to retrieve from.","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"name":"sort","in":"query","description":"Sort the results in the ascending/descending order of record creation.\nDefault order is **descending** if `sort` is not passed","required":false,"schema":{"$ref":"#/components/schemas/ProcessesGetParametersSort","default":"desc"}},{"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":"Background processes retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process_getProcesses_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProcessesRequestBadRequestError"}}}}}}},"/processes/{processId}":{"get":{"operationId":"getProcess","summary":"Get process details","description":"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**Important considerations:**\n- Process ID must exist in your account and not be deleted\n- Completed export processes include download URLs\n- Completed import processes include CSV report URLs with details about problematic records\n- Different process types return different result structures\n","tags":["process"],"parameters":[{"name":"processId","in":"path","description":"Id of the process","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Process information retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process_getProcess_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProcessRequestBadRequestError"}}}},"404":{"description":"Process ID not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/feeds":{"get":{"operationId":"getAllExternalFeeds","summary":"Get all external feeds","description":"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 information\n- Authentication and header configurations\n\n**Important considerations:**\n- External feeds enable dynamic content in email campaigns\n- Feeds must be accessible from Brevo servers\n- Authentication credentials are securely stored\n- Feed performance affects campaign delivery\n- Use pagination for accounts with many feeds\n- Date range filtering limited to 30 days maximum\n- Search functionality works on feed name matching\n- Internal feeds are system-managed and cannot be modified\n","tags":["externalFeeds"],"parameters":[{"name":"search","in":"query","description":"Can be used to filter records by search keyword on feed name","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"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.","required":false,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"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.","required":false,"schema":{"type":"string","format":"date"}},{"name":"sort","in":"query","description":"Sort the results in the ascending/descending order of record creation.\nDefault order is **descending** if `sort` is not passed.","required":false,"schema":{"$ref":"#/components/schemas/FeedsGetParametersSort","default":"desc"}},{"name":"authType","in":"query","description":"Filter the records by `authType` of the feed.","required":false,"schema":{"$ref":"#/components/schemas/FeedsGetParametersAuthType"}},{"name":"limit","in":"query","description":"Number of documents returned per page.","required":false,"schema":{"type":"integer","format":"int64","default":50}},{"name":"offset","in":"query","description":"Index of the first document on the page.","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"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":"External feeds retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/External Feeds_getAllExternalFeeds_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllExternalFeedsRequestBadRequestError"}}}},"404":{"description":"Record not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"post":{"operationId":"createExternalFeed","summary":"Create external feed","description":"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 credentials are securely encrypted\n- Test feed accessibility before campaign use\n- Consider feed response time for campaign performance\n- Monitor feed reliability and uptime\n- Use caching for frequently accessed feeds\n- Maximum 5 retry attempts allowed for failed requests\n- Custom headers support for API integration requirements\n","tags":["externalFeeds"],"parameters":[{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"External feed created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/External Feeds_createExternalFeed_Response_201"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalFeedRequestBadRequestError"}}}}},"requestBody":{"description":"External feed configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the feed"},"url":{"type":"string","format":"url","description":"URL of the external data source"},"authType":{"$ref":"#/components/schemas/FeedsPostRequestBodyContentApplicationJsonSchemaAuthType","default":"noAuth","description":"Authentication type for accessing the feed"},"username":{"type":"string","description":"Username for basic authentication (required if authType is 'basic')"},"password":{"type":"string","description":"Password for basic authentication (required if authType is 'basic')"},"token":{"type":"string","description":"Token for token-based authentication (required if authType is 'token')"},"maxRetries":{"type":"integer","default":5,"description":"Maximum number of retry attempts for failed requests"},"cache":{"type":"boolean","default":true,"description":"Whether to cache the feed response"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/FeedsPostRequestBodyContentApplicationJsonSchemaHeadersItems"},"description":"Custom HTTP headers for the feed request"}},"required":["name","url"]}}}}}},"/feeds/{uuid}":{"get":{"operationId":"getExternalFeedByUUID","summary":"Get external feed details","description":"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**Important considerations:**\n- UUID must exist in your account\n- Provides complete feed information for troubleshooting\n- Essential before making modifications\n- Shows current feed health status\n- Useful for debugging feed issues\n","tags":["externalFeeds"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the feed to fetch","required":true,"schema":{"type":"string","format":"uuidv4"}},{"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":"External feed details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/External Feeds_getExternalFeedByUUID_Response_200"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExternalFeedByUUIDRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExternalFeedByUUIDRequestNotFoundError"}}}}}},"put":{"operationId":"updateExternalFeed","summary":"Update external feed","description":"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 before campaign use\n- Monitor campaigns using this feed after updates\n","tags":["externalFeeds"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the feed to update","required":true,"schema":{"type":"string","format":"uuidv4"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"External feed updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalFeedRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalFeedRequestNotFoundError"}}}}},"requestBody":{"description":"Feed configuration updates","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the feed"},"url":{"type":"string","format":"url","description":"URL of the external data source"},"authType":{"$ref":"#/components/schemas/FeedsUuidPutRequestBodyContentApplicationJsonSchemaAuthType","description":"Authentication type for accessing the feed"},"username":{"type":"string","description":"Username for basic authentication"},"password":{"type":"string","description":"Password for basic authentication"},"token":{"type":"string","description":"Token for token-based authentication"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/FeedsUuidPutRequestBodyContentApplicationJsonSchemaHeadersItems"},"description":"Custom HTTP headers for the feed request"},"maxRetries":{"type":"integer","description":"Maximum number of retry attempts for failed requests"},"cache":{"type":"boolean","description":"Whether to cache the feed response"}}}}}}},"delete":{"operationId":"deleteExternalFeed","summary":"Delete external feed","description":"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 templates\n- Consider deactivating instead of deleting if unsure\n","tags":["externalFeeds"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the feed to delete","required":true,"schema":{"type":"string","format":"uuidv4"}},{"name":"api-key","in":"header","description":"The API key should be passed in the request headers as `api-key` for authentication.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"External feed deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalFeedRequestBadRequestError"}}}},"404":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalFeedRequestNotFoundError"}}}}}}}},"servers":[{"url":"https://api.brevo.com/v3","description":"https://api.brevo.com/v3"}],"components":{"schemas":{"SendersGetResponsesContentApplicationJsonSchemaSendersItemsIpsItems":{"type":"object","properties":{"domain":{"type":"string","description":"Domain of the IP"},"ip":{"type":"string","description":"Dedicated IP available in your account"},"weight":{"type":"integer","format":"int64","description":"Weight of the IP for this sender"}},"required":["domain","ip","weight"],"title":"SendersGetResponsesContentApplicationJsonSchemaSendersItemsIpsItems"},"SendersGetResponsesContentApplicationJsonSchemaSendersItems":{"type":"object","properties":{"active":{"type":"boolean","description":"Status of sender (true=activated, false=deactivated)"},"email":{"type":"string","format":"email","description":"From Email associated to the sender"},"id":{"type":"integer","format":"int64","description":"Id of the sender"},"ips":{"type":"array","items":{"$ref":"#/components/schemas/SendersGetResponsesContentApplicationJsonSchemaSendersItemsIpsItems"},"description":"List of dedicated IP(s) available in the account. This\ndata is displayed only for dedicated IPs. For standard accounts,\nthis will be an empty array."},"name":{"type":"string","description":"From Name associated to the sender"}},"required":["active","email","id","ips","name"],"title":"SendersGetResponsesContentApplicationJsonSchemaSendersItems"},"Senders_getSenders_Response_200":{"type":"object","properties":{"senders":{"type":"array","items":{"$ref":"#/components/schemas/SendersGetResponsesContentApplicationJsonSchemaSendersItems"},"description":"List of the senders available in your account"}},"title":"Senders_getSenders_Response_200"},"SendersGetResponsesContentApplicationJsonSchemaCode":{"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":"SendersGetResponsesContentApplicationJsonSchemaCode"},"GetSendersRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetSendersRequestBadRequestError"},"SendersPostRequestBodyContentApplicationJsonSchemaIpsItems":{"type":"object","properties":{"domain":{"type":"string","description":"Domain of the IP"},"ip":{"type":"string","description":"Dedicated IP available in your account"},"weight":{"type":"integer","format":"int64","description":"Weight to apply to the IP. Sum of all IP weights must be\n100. Should be passed for either ALL or NONE of the IPs.\nIf it's not passed, the sending will be equally balanced\non all IPs."}},"required":["domain","ip"],"title":"SendersPostRequestBodyContentApplicationJsonSchemaIpsItems"},"Senders_createSender_Response_201":{"type":"object","properties":{"dkimError":{"type":"boolean","description":"Status of DKIM configuration for the sender (true = DKIM not\nwell configured, false = DKIM well configured)"},"id":{"type":"integer","format":"int64","description":"ID of the Sender created"},"spfError":{"type":"boolean","description":"Status of SPF configuration for the sender (true = SPF not\nwell configured, false = SPF well configured)"}},"required":["id"],"title":"Senders_createSender_Response_201"},"SendersPostResponsesContentApplicationJsonSchemaCode":{"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":"SendersPostResponsesContentApplicationJsonSchemaCode"},"CreateSenderRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersPostResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"CreateSenderRequestBadRequestError"},"SendersSenderIdPutRequestBodyContentApplicationJsonSchemaIpsItems":{"type":"object","properties":{"domain":{"type":"string","description":"Domain of the IP"},"ip":{"type":"string","description":"Dedicated IP available in your account"},"weight":{"type":"integer","format":"int64","description":"Weight to apply to the IP. Sum of all IP weights must be\n100. Should be passed for either ALL or NONE of the IPs.\nIf it's not passed, the sending will be equally balanced\non all IPs."}},"required":["domain","ip"],"title":"SendersSenderIdPutRequestBodyContentApplicationJsonSchemaIpsItems"},"SendersSenderIdPutResponsesContentApplicationJsonSchemaCode":{"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":"SendersSenderIdPutResponsesContentApplicationJsonSchemaCode"},"UpdateSenderRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersSenderIdPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateSenderRequestBadRequestError"},"errorModel":{"type":"object","properties":{"code":{"type":"string","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["message"],"title":"errorModel"},"SendersSenderIdDeleteResponsesContentApplicationJsonSchemaCode":{"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":"SendersSenderIdDeleteResponsesContentApplicationJsonSchemaCode"},"DeleteSenderRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersSenderIdDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteSenderRequestBadRequestError"},"SendersSenderIdValidatePutResponsesContentApplicationJsonSchemaCode":{"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":"SendersSenderIdValidatePutResponsesContentApplicationJsonSchemaCode"},"ValidateSenderByOTPRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersSenderIdValidatePutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"ValidateSenderByOTPRequestBadRequestError"},"SendersIpsGetResponsesContentApplicationJsonSchemaIpsItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the dedicated IP"},"active":{"type":"boolean","description":"Status of the IP (true=active, false=inactive)"},"domain":{"type":"string","description":"Domain associated to the IP"},"ip":{"type":"string","description":"Dedicated IP address"}},"required":["id","active","domain","ip"],"title":"SendersIpsGetResponsesContentApplicationJsonSchemaIpsItems"},"Senders_getIps_Response_200":{"type":"object","properties":{"ips":{"type":"array","items":{"$ref":"#/components/schemas/SendersIpsGetResponsesContentApplicationJsonSchemaIpsItems"},"description":"Dedicated IP(s) available on your account. Returns empty array\nfor standard accounts without dedicated IPs."}},"required":["ips"],"title":"Senders_getIps_Response_200"},"SendersIpsGetResponsesContentApplicationJsonSchemaCode":{"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":"SendersIpsGetResponsesContentApplicationJsonSchemaCode"},"GetIpsRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersIpsGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetIpsRequestBadRequestError"},"SendersSenderIdIpsGetResponsesContentApplicationJsonSchemaIpsItems":{"type":"object","properties":{"domain":{"type":"string","description":"Domain associated to the IP"},"id":{"type":"integer","format":"int64","description":"ID of the dedicated IP"},"ip":{"type":"string","description":"Dedicated IP address"},"weight":{"type":"integer","format":"int64","description":"Weight of the IP for this sender"}},"required":["domain","id","ip","weight"],"title":"SendersSenderIdIpsGetResponsesContentApplicationJsonSchemaIpsItems"},"Senders_getIpsFromSender_Response_200":{"type":"object","properties":{"ips":{"type":"array","items":{"$ref":"#/components/schemas/SendersSenderIdIpsGetResponsesContentApplicationJsonSchemaIpsItems"},"description":"Dedicated IP(s) linked to a sender. Returns empty array for standard accounts\nwithout dedicated IPs."}},"required":["ips"],"title":"Senders_getIpsFromSender_Response_200"},"SendersSenderIdIpsGetResponsesContentApplicationJsonSchemaCode":{"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":"SendersSenderIdIpsGetResponsesContentApplicationJsonSchemaCode"},"GetIpsFromSenderRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersSenderIdIpsGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetIpsFromSenderRequestBadRequestError"},"SendersDomainsGetResponsesContentApplicationJsonSchemaDomainsItemsCreator":{"type":"object","properties":{"id":{"type":"string","description":"Creator's user ID"},"email":{"type":"string","description":"Creator's email address"},"creationDate":{"type":"string","format":"date-time","description":"Domain creation date"}},"required":["id","email","creationDate"],"description":"Information about who created the domain","title":"SendersDomainsGetResponsesContentApplicationJsonSchemaDomainsItemsCreator"},"SendersDomainsGetResponsesContentApplicationJsonSchemaDomainsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the domain"},"domain_name":{"type":"string","description":"Domain name"},"authenticated":{"type":"boolean","description":"Status of domain authentication (true=authenticated,\nfalse=non authenticated)"},"verified":{"type":"boolean","description":"Status of domain verification (true=verified, false=non\nverified)"},"ip":{"type":["string","null"],"description":"Dedicated IP associated with domain (null if none)"},"provider":{"type":"string","description":"DNS provider for the domain"},"creator":{"$ref":"#/components/schemas/SendersDomainsGetResponsesContentApplicationJsonSchemaDomainsItemsCreator","description":"Information about who created the domain"}},"required":["id","domain_name","authenticated","verified","provider","creator"],"title":"SendersDomainsGetResponsesContentApplicationJsonSchemaDomainsItems"},"Domains_getDomains_Response_200":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/components/schemas/SendersDomainsGetResponsesContentApplicationJsonSchemaDomainsItems"},"description":"List of the domains available in your account"},"count":{"type":"integer","description":"Total number of domains"},"current_page":{"type":"integer","description":"Current page number"},"total_pages":{"type":"integer","description":"Total number of pages"}},"required":["domains","count","current_page","total_pages"],"title":"Domains_getDomains_Response_200"},"SendersDomainsGetResponsesContentApplicationJsonSchemaCode":{"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":"SendersDomainsGetResponsesContentApplicationJsonSchemaCode"},"GetDomainsRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetDomainsRequestBadRequestError"},"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsBrevoCode":{"type":"object","properties":{"host_name":{"type":"string","description":"DNS record hostname"},"type":{"type":"string","description":"DNS record type"},"value":{"type":"string","description":"DNS record value"},"status":{"type":"boolean","description":"Whether the record is properly configured"}},"required":["host_name","type","value","status"],"description":"Brevo verification code record","title":"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsBrevoCode"},"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsDkimRecord":{"type":"object","properties":{"host_name":{"type":"string","description":"DNS record hostname"},"type":{"type":"string","description":"DNS record type"},"value":{"type":"string","description":"DNS record value"},"status":{"type":"boolean","description":"Whether the record is properly configured"}},"required":["host_name","type","value","status"],"description":"DKIM authentication record","title":"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsDkimRecord"},"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsDmarcRecord":{"type":"object","properties":{"host_name":{"type":"string","description":"DNS record hostname"},"type":{"type":"string","description":"DNS record type"},"value":{"type":"string","description":"DNS record value"},"status":{"type":"boolean","description":"Whether the record is properly configured"}},"required":["host_name","type","value","status"],"description":"DMARC policy record","title":"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsDmarcRecord"},"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecords":{"type":"object","properties":{"brevo_code":{"$ref":"#/components/schemas/SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsBrevoCode","description":"Brevo verification code record"},"dkim_record":{"$ref":"#/components/schemas/SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsDkimRecord","description":"DKIM authentication record"},"dmarc_record":{"$ref":"#/components/schemas/SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecordsDmarcRecord","description":"DMARC policy record"}},"required":["brevo_code","dkim_record","dmarc_record"],"description":"DNS records required for domain authentication","title":"SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecords"},"Domains_createDomain_Response_200":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the Domain created"},"domain_name":{"type":"string","description":"Domain name"},"domain_provider":{"type":"string","description":"Detected domain provider"},"message":{"type":"string","description":"Success message with next steps"},"dns_records":{"$ref":"#/components/schemas/SendersDomainsPostResponsesContentApplicationJsonSchemaDnsRecords","description":"DNS records required for domain authentication"}},"required":["id","domain_name","message"],"title":"Domains_createDomain_Response_200"},"SendersDomainsPostResponsesContentApplicationJsonSchemaCode":{"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":"SendersDomainsPostResponsesContentApplicationJsonSchemaCode"},"CreateDomainRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsPostResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"CreateDomainRequestBadRequestError"},"Domains_deleteDomain_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Domains_deleteDomain_Response_200"},"SendersDomainsDomainNameDeleteResponsesContentApplicationJsonSchemaCode":{"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":"SendersDomainsDomainNameDeleteResponsesContentApplicationJsonSchemaCode"},"DeleteDomainRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsDomainNameDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteDomainRequestBadRequestError"},"DeleteDomainRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsDomainNameDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteDomainRequestNotFoundError"},"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsBrevoCode":{"type":"object","properties":{"host_name":{"type":"string","description":"DNS record hostname"},"type":{"type":"string","description":"DNS record type"},"value":{"type":"string","description":"DNS record value"},"status":{"type":"boolean","description":"Whether the record is properly configured"}},"required":["host_name","type","value","status"],"description":"Brevo verification code record","title":"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsBrevoCode"},"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsDkimRecord":{"type":"object","properties":{"host_name":{"type":"string","description":"DNS record hostname"},"type":{"type":"string","description":"DNS record type"},"value":{"type":"string","description":"DNS record value"},"status":{"type":"boolean","description":"Whether the record is properly configured"}},"required":["host_name","type","value","status"],"description":"DKIM authentication record","title":"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsDkimRecord"},"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsDmarcRecord":{"type":"object","properties":{"host_name":{"type":"string","description":"DNS record hostname"},"type":{"type":"string","description":"DNS record type"},"value":{"type":"string","description":"DNS record value"},"status":{"type":"boolean","description":"Whether the record is properly configured"}},"required":["host_name","type","value","status"],"description":"DMARC policy record","title":"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsDmarcRecord"},"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecords":{"type":"object","properties":{"brevo_code":{"$ref":"#/components/schemas/SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsBrevoCode","description":"Brevo verification code record"},"dkim_record":{"$ref":"#/components/schemas/SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsDkimRecord","description":"DKIM authentication record"},"dmarc_record":{"$ref":"#/components/schemas/SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecordsDmarcRecord","description":"DMARC policy record"}},"required":["brevo_code","dkim_record","dmarc_record"],"description":"DNS records configuration and status","title":"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecords"},"Domains_getDomainConfiguration_Response_200":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name"},"verified":{"type":"boolean","description":"Status of domain verification (true=verified, false=non\nverified)"},"authenticated":{"type":"boolean","description":"Status of domain authentication (true=authenticated, false=non\nauthenticated)"},"dns_records":{"$ref":"#/components/schemas/SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaDnsRecords","description":"DNS records configuration and status"}},"required":["domain","verified","authenticated","dns_records"],"title":"Domains_getDomainConfiguration_Response_200"},"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaCode":{"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":"SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaCode"},"GetDomainConfigurationRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetDomainConfigurationRequestBadRequestError"},"GetDomainConfigurationRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsDomainNameGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetDomainConfigurationRequestNotFoundError"},"Domains_authenticateDomain_Response_200":{"type":"object","properties":{"domain_name":{"type":"string","description":"Domain name that was authenticated"},"message":{"type":"string","description":"Success message confirming authentication"}},"required":["domain_name","message"],"title":"Domains_authenticateDomain_Response_200"},"SendersDomainsDomainNameAuthenticatePutResponsesContentApplicationJsonSchemaCode":{"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":"SendersDomainsDomainNameAuthenticatePutResponsesContentApplicationJsonSchemaCode"},"AuthenticateDomainRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsDomainNameAuthenticatePutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"AuthenticateDomainRequestBadRequestError"},"AuthenticateDomainRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/SendersDomainsDomainNameAuthenticatePutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"AuthenticateDomainRequestNotFoundError"},"WebhooksGetParametersType":{"type":"string","enum":["marketing","transactional","inbound"],"default":"transactional","title":"WebhooksGetParametersType"},"WebhooksGetParametersSort":{"type":"string","enum":["asc","desc"],"default":"desc","title":"WebhooksGetParametersSort"},"GetWebhookAuth":{"type":"object","properties":{},"description":"Authentication header to be send with the webhook requests","title":"GetWebhookAuth"},"GetWebhookHeadersItems":{"type":"object","properties":{},"description":"Headers send with the requests to the webhook","title":"GetWebhookHeadersItems"},"GetWebhookType":{"type":"string","enum":["marketing","transactional","inbound"],"description":"Type of webhook (marketing, transactional, or inbound)","title":"GetWebhookType"},"getWebhook":{"type":"object","properties":{"auth":{"$ref":"#/components/schemas/GetWebhookAuth","description":"Authentication header to be send with the webhook requests"},"batched":{"type":"boolean","description":"Batching configuration of the webhook, we send batched webhooks if its\ntrue"},"createdAt":{"type":"string","description":"Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)"},"description":{"type":"string","description":"Description of the webhook"},"events":{"type":"array","items":{"type":"string"}},"headers":{"type":"array","items":{"$ref":"#/components/schemas/GetWebhookHeadersItems"}},"id":{"type":"integer","format":"int64","description":"ID of the webhook"},"modifiedAt":{"type":"string","description":"Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)"},"type":{"$ref":"#/components/schemas/GetWebhookType","description":"Type of webhook (marketing, transactional, or inbound)"},"domain":{"type":"string","description":"Inbound domain of the webhook, only returned for inbound type webhooks"},"url":{"type":"string","format":"url","description":"URL of the webhook"}},"required":["createdAt","description","events","id","modifiedAt","type","url"],"title":"getWebhook"},"Webhooks_getWebhooks_Response_200":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/getWebhook"}}},"required":["webhooks"],"title":"Webhooks_getWebhooks_Response_200"},"WebhooksGetResponsesContentApplicationJsonSchemaCode":{"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":"WebhooksGetResponsesContentApplicationJsonSchemaCode"},"GetWebhooksRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetWebhooksRequestBadRequestError"},"WebhooksPostRequestBodyContentApplicationJsonSchemaAuth":{"type":"object","properties":{"token":{"type":"string","description":"Webhook authentication token"},"type":{"type":"string","description":"Type of authentication"}},"description":"Add authentication on webhook url","title":"WebhooksPostRequestBodyContentApplicationJsonSchemaAuth"},"WebhooksPostRequestBodyContentApplicationJsonSchemaChannel":{"type":"string","enum":["email","sms"],"default":"email","description":"Channel of the webhook","title":"WebhooksPostRequestBodyContentApplicationJsonSchemaChannel"},"WebhooksPostRequestBodyContentApplicationJsonSchemaEventsItems":{"type":"string","enum":["sent","hardBounce","softBounce","blocked","spam","delivered","request","click","invalid","deferred","opened","uniqueOpened","unsubscribed","listAddition","contactUpdated","contactDeleted","inboundEmailProcessed","reply"],"title":"WebhooksPostRequestBodyContentApplicationJsonSchemaEventsItems"},"WebhooksPostRequestBodyContentApplicationJsonSchemaHeadersItems":{"type":"object","properties":{"key":{"type":"string","description":"Header key name"},"value":{"type":"string","description":"Header value"}},"title":"WebhooksPostRequestBodyContentApplicationJsonSchemaHeadersItems"},"WebhooksPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["transactional","marketing","inbound"],"default":"transactional","description":"Type of the webhook","title":"WebhooksPostRequestBodyContentApplicationJsonSchemaType"},"Webhooks_createWebhook_Response_201":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the object created"}},"required":["id"],"title":"Webhooks_createWebhook_Response_201"},"WebhooksPostResponsesContentApplicationJsonSchemaCode":{"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":"WebhooksPostResponsesContentApplicationJsonSchemaCode"},"CreateWebhookRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksPostResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"CreateWebhookRequestBadRequestError"},"WebhooksWebhookIdGetResponsesContentApplicationJsonSchemaCode":{"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":"WebhooksWebhookIdGetResponsesContentApplicationJsonSchemaCode"},"GetWebhookRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksWebhookIdGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetWebhookRequestBadRequestError"},"GetWebhookRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksWebhookIdGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetWebhookRequestNotFoundError"},"WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaAuth":{"type":"object","properties":{"token":{"type":"string","description":"Webhook authentication token"},"type":{"type":"string","description":"Type of authentication"}},"description":"Add authentication on webhook url","title":"WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaAuth"},"WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaEventsItems":{"type":"string","enum":["sent","hardBounce","softBounce","blocked","spam","delivered","request","click","invalid","deferred","opened","uniqueOpened","unsubscribed","listAddition","contactUpdated","contactDeleted","inboundEmailProcessed","reply"],"title":"WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaEventsItems"},"WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaHeadersItems":{"type":"object","properties":{"key":{"type":"string","description":"Header key name"},"value":{"type":"string","description":"Header value"}},"title":"WebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaHeadersItems"},"WebhooksWebhookIdPutResponsesContentApplicationJsonSchemaCode":{"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":"WebhooksWebhookIdPutResponsesContentApplicationJsonSchemaCode"},"UpdateWebhookRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksWebhookIdPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateWebhookRequestBadRequestError"},"UpdateWebhookRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksWebhookIdPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateWebhookRequestNotFoundError"},"WebhooksWebhookIdDeleteResponsesContentApplicationJsonSchemaCode":{"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":"WebhooksWebhookIdDeleteResponsesContentApplicationJsonSchemaCode"},"DeleteWebhookRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksWebhookIdDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteWebhookRequestBadRequestError"},"DeleteWebhookRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksWebhookIdDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteWebhookRequestNotFoundError"},"Webhooks_exportWebhooksHistory_Request":{"oneOf":[{"description":"Reference to WebhooksExportWebhooksHistoryRequest0"}],"title":"Webhooks_exportWebhooksHistory_Request"},"Webhooks_exportWebhooksHistory_Response_202":{"type":"object","properties":{"processId":{"type":"integer","format":"int64","description":"Id of the process created"}},"required":["processId"],"title":"Webhooks_exportWebhooksHistory_Response_202"},"WebhooksExportPostResponsesContentApplicationJsonSchemaCode":{"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":"WebhooksExportPostResponsesContentApplicationJsonSchemaCode"},"ExportWebhooksHistoryRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WebhooksExportPostResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"ExportWebhooksHistoryRequestBadRequestError"},"AccountGetResponsesContentApplicationJsonSchemaAddress":{"type":"object","properties":{"city":{"type":"string","description":"City information"},"country":{"type":"string","description":"Country information"},"street":{"type":"string","description":"Street information"},"zipCode":{"type":"string","description":"Zip Code information"}},"required":["city","country","street","zipCode"],"description":"Address informations","title":"AccountGetResponsesContentApplicationJsonSchemaAddress"},"AccountGetResponsesContentApplicationJsonSchemaMarketingAutomation":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Status of Marketing Automation Plateform activation\nfor your account (true=enabled, false=disabled)"},"key":{"type":"string","description":"Marketing Automation Tracker ID"}},"required":["enabled"],"title":"AccountGetResponsesContentApplicationJsonSchemaMarketingAutomation"},"AccountGetResponsesContentApplicationJsonSchemaPlanItemsCreditsType":{"type":"string","enum":["sendLimit"],"description":"This is the type of the credit, \"Send Limit\" is one\nof the possible types of credit of a user. \"Send\nLimit\" implies the total number of emails you can\nsend to the subscribers in your account.","title":"AccountGetResponsesContentApplicationJsonSchemaPlanItemsCreditsType"},"AccountGetResponsesContentApplicationJsonSchemaPlanItemsType":{"type":"string","enum":["payAsYouGo","free","subscription","sms"],"description":"Displays the plan type of the user","title":"AccountGetResponsesContentApplicationJsonSchemaPlanItemsType"},"AccountGetResponsesContentApplicationJsonSchemaPlanItems":{"type":"object","properties":{"credits":{"type":"string","title":"float","description":"Remaining credits of the user"},"creditsType":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanItemsCreditsType","description":"This is the type of the credit, \"Send Limit\" is one\nof the possible types of credit of a user. \"Send\nLimit\" implies the total number of emails you can\nsend to the subscribers in your account."},"endDate":{"type":"string","description":"Date of the period from which the plan will end\n(Unix timestamp format)"},"startDate":{"type":"string","description":"Date of the period from which the plan will start\n(Unix timestamp format)"},"type":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanItemsType","description":"Displays the plan type of the user"}},"required":["credits","creditsType","type"],"title":"AccountGetResponsesContentApplicationJsonSchemaPlanItems"},"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsPlanCategory":{"type":"string","enum":["Marketing","Chat","CRM"],"description":"Category of the plan","title":"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsPlanCategory"},"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsStatus":{"type":"string","enum":["active","inactive"],"description":"Current status of the plan","title":"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsStatus"},"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsUsers":{"type":"object","properties":{"purchasedSeats":{"type":"string","description":"Number of purchased user seats"},"usedSeats":{"type":"string","description":"Number of used user seats"}},"required":["purchasedSeats","usedSeats"],"description":"User seat information for the plan","title":"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsUsers"},"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItems":{"type":"object","properties":{"planCategory":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsPlanCategory","description":"Category of the plan"},"planType":{"type":"string","description":"Type of plan within the category"},"name":{"type":"string","description":"Name of the plan"},"status":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsStatus","description":"Current status of the plan"},"startDate":{"type":"string","description":"Plan start date (Unix timestamp)"},"endDate":{"type":"string","description":"Plan end date (Unix timestamp)"},"users":{"oneOf":[{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItemsUsers"},{"type":"null"}],"description":"User seat information for the plan"},"credits":{"type":"string","description":"Credits allocated for this plan category (optional, may not be present for all plan categories)"}},"required":["planCategory","planType","name","status"],"title":"AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItems"},"AccountGetResponsesContentApplicationJsonSchemaRelayData":{"type":"object","properties":{"port":{"type":"integer","description":"Port used for SMTP Relay"},"relay":{"type":"string","description":"URL of the SMTP Relay"},"userName":{"type":"string","format":"email","description":"Email to use as login on transactional platform"}},"required":["port","relay","userName"],"description":"Data regarding the transactional email account","title":"AccountGetResponsesContentApplicationJsonSchemaRelayData"},"AccountGetResponsesContentApplicationJsonSchemaRelay":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaRelayData","description":"Data regarding the transactional email account"},"enabled":{"type":"boolean","description":"Status of your transactional email Account\n(true=Enabled, false=Disabled)"}},"required":["data","enabled"],"description":"Information about your transactional email account","title":"AccountGetResponsesContentApplicationJsonSchemaRelay"},"Account_getAccount_Response_200":{"type":"object","properties":{"organization_id":{"type":"string","description":"Unique identifier for the organization"},"user_id":{"type":"integer","description":"Unique identifier for the user"},"enterprise":{"type":"boolean","description":"Indicates if the account has enterprise features"},"companyName":{"type":"string","description":"Name of the company"},"email":{"type":"string","format":"email","description":"Login Email"},"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"Last Name"},"address":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaAddress","description":"Address informations"},"marketingAutomation":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaMarketingAutomation"},"plan":{"type":"array","items":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanItems"},"description":"Information about your plans and credits"},"planVerticals":{"type":"array","items":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaPlanVerticalsItems"},"description":"Detailed information about different plan categories"},"relay":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaRelay","description":"Information about your transactional email account"}},"required":["organization_id","user_id","enterprise","companyName","email","firstName","lastName","plan","relay"],"title":"Account_getAccount_Response_200"},"AccountGetResponsesContentApplicationJsonSchemaCode":{"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":"AccountGetResponsesContentApplicationJsonSchemaCode"},"GetAccountRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetAccountRequestBadRequestError"},"OrganizationActivitiesGetResponsesContentApplicationJsonSchemaLogsItems":{"type":"object","properties":{"action":{"type":"string","description":"Type of activity in the account."},"date":{"type":"string","description":"Time of the activity."},"user_agent":{"type":"string","description":"Browser details of the user who performed the activity."},"user_email":{"type":"string","description":"Email address of the user who performed activity in the\naccount."},"user_ip":{"type":"string","description":"IP address of the user who performed activity in the\naccount."}},"required":["action","date","user_agent","user_email","user_ip"],"title":"OrganizationActivitiesGetResponsesContentApplicationJsonSchemaLogsItems"},"Account_getAccountActivity_Response_200":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationActivitiesGetResponsesContentApplicationJsonSchemaLogsItems"},"description":"Get user activity logs"}},"title":"Account_getAccountActivity_Response_200"},"OrganizationActivitiesGetResponsesContentApplicationJsonSchemaCode":{"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":"OrganizationActivitiesGetResponsesContentApplicationJsonSchemaCode"},"GetAccountActivityRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/OrganizationActivitiesGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetAccountActivityRequestBadRequestError"},"CorporateSubAccountGetResponsesContentApplicationJsonSchemaSubAccountsItemsGroupsItems":{"type":"object","properties":{"id":{"type":"string","description":"Group identifier"},"name":{"type":"string","description":"Name of the group"}},"title":"CorporateSubAccountGetResponsesContentApplicationJsonSchemaSubAccountsItemsGroupsItems"},"CorporateSubAccountGetResponsesContentApplicationJsonSchemaSubAccountsItems":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the sub-account is active or not"},"companyName":{"type":"string","description":"Name of the sub-account company"},"createdAt":{"type":"integer","format":"int64","description":"Timestamp when the sub-account was created"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CorporateSubAccountGetResponsesContentApplicationJsonSchemaSubAccountsItemsGroupsItems"},"description":"Group details"},"id":{"type":"integer","format":"int64","description":"id of the sub-account"}},"required":["active","companyName","createdAt","groups","id"],"title":"CorporateSubAccountGetResponsesContentApplicationJsonSchemaSubAccountsItems"},"Master account_getTheListOfAllTheSubAccountsOfTheMasterAccount_Response_200":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of subaccounts"},"subAccounts":{"type":"array","items":{"$ref":"#/components/schemas/CorporateSubAccountGetResponsesContentApplicationJsonSchemaSubAccountsItems"}}},"title":"Master account_getTheListOfAllTheSubAccountsOfTheMasterAccount_Response_200"},"CorporateSubAccountGetResponsesContentApplicationJsonSchemaCode":{"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":"CorporateSubAccountGetResponsesContentApplicationJsonSchemaCode"},"GetTheListOfAllTheSubAccountsOfTheMasterAccountRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateSubAccountGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetTheListOfAllTheSubAccountsOfTheMasterAccountRequestBadRequestError"},"CorporateSubAccountPostRequestBodyContentApplicationJsonSchemaLanguage":{"type":"string","enum":["en","fr","it","es","pt","de"],"description":"Set the language of the sub-account","title":"CorporateSubAccountPostRequestBodyContentApplicationJsonSchemaLanguage"},"Master account_createANewSubAccountUnderAMasterAccount_Response_201":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the sub-account created"}},"required":["id"],"title":"Master account_createANewSubAccountUnderAMasterAccount_Response_201"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaGroupsItems":{"type":"object","properties":{"id":{"type":"string","description":"Group id"},"name":{"type":"string","description":"Name of the group"}},"title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaGroupsItems"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsEmails":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of email messaging limits provided"},"remaining":{"type":"integer","format":"int64","description":"Available email messaging limits for use"}},"description":"Email credits remaining on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsEmails"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsExternalFeeds":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of externalFeeds messaging limits\nprovided"},"remaining":{"type":"integer","format":"int64","description":"Available externalFeeds messaging limits for use"}},"description":"externalFeeds credits remaining on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsExternalFeeds"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsSms":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of SMS messaging limits provided"},"remaining":{"type":"integer","format":"int64","description":"Available SMS messaging limits for use"}},"description":"SMS credits remaining on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsSms"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsWhatsapp":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of whatsapp messaging limits provided"},"remaining":{"type":"integer","format":"int64","description":"Available whatsapp messaging limits for use"}},"description":"Whatsapp credits remaining on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsWhatsapp"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsWpSubscribers":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of Push sending limits provided"},"remaining":{"type":"integer","format":"int64","description":"Available Push sending limits for use"}},"description":"Push credits remaining on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsWpSubscribers"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCredits":{"type":"object","properties":{"emails":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsEmails","description":"Email credits remaining on the sub-account"},"externalFeeds":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsExternalFeeds","description":"externalFeeds credits remaining on the sub-account"},"sms":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsSms","description":"SMS credits remaining on the sub-account"},"whatsapp":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsWhatsapp","description":"Whatsapp credits remaining on the sub-account"},"wpSubscribers":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCreditsWpSubscribers","description":"Push credits remaining on the sub-account"}},"description":"Credits quota and remaining credits on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCredits"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesInbox":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of inbox provided"},"remaining":{"type":"integer","format":"int64","description":"Available inboxes for use"}},"description":"Inbox details / Not applicable on ENTv2","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesInbox"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesLandingPage":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of landing pages provided"},"remaining":{"type":"integer","format":"int64","description":"Available landing pages for use"}},"description":"Landing page details / Not applicable on ENTv2","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesLandingPage"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesSalesUsers":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of sales users provided"},"remaining":{"type":"integer","format":"int64","description":"Available sales users for use"}},"description":"Sales and service users to use phone, sales and\nconversations","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesSalesUsers"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesUsers":{"type":"object","properties":{"quantity":{"type":"integer","format":"int64","description":"Quantity of marketing users provided"},"remaining":{"type":"integer","format":"int64","description":"Available marketing users for use"}},"description":"Marketing users to manage the marketing channels","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesUsers"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeatures":{"type":"object","properties":{"inbox":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesInbox","description":"Inbox details / Not applicable on ENTv2"},"landingPage":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesLandingPage","description":"Landing page details / Not applicable on ENTv2"},"salesUsers":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesSalesUsers","description":"Sales and service users to use phone, sales and\nconversations"},"users":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesUsers","description":"Marketing users to manage the marketing channels"}},"description":"Features available on the sub-account","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeatures"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfo":{"type":"object","properties":{"credits":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoCredits","description":"Credits quota and remaining credits on the sub-account"},"features":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfoFeatures","description":"Features available on the sub-account"},"planType":{"type":"string","description":"type of the plan"}},"description":"Sub-account plan details","title":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfo"},"Master account_getSubAccountDetails_Response_200":{"type":"object","properties":{"companyName":{"type":"string","description":"Sub-account company name"},"email":{"type":"string","description":"Email id of the sub-account organization"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaGroupsItems"},"description":"List of groups associated with the sub-account"},"name":{"type":"string","description":"Name of the sub-account user"},"planInfo":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaPlanInfo","description":"Sub-account plan details"}},"title":"Master account_getSubAccountDetails_Response_200"},"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaCode":{"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":"CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaCode"},"GetSubAccountDetailsRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateSubAccountIdGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetSubAccountDetailsRequestBadRequestError"},"CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaCredits":{"type":"object","properties":{"email":{"type":"integer","format":"int64","description":"Number of email credits | Pass the value -1 for unlimited\nemails in ENTv2 only"},"externalFeeds":{"type":"integer","format":"int64","description":"Number of externalFeeds credits, possible values are 0 or 1\n|available in ENTv2 only"},"sms":{"type":"string","title":"float","description":"Number of SMS credits | Pass the value -1 for unlimited SMS\nin ENTv2 only"},"whatsapp":{"type":"string","title":"float","description":"Number of whatsapp credits | Pass the value -1 for unlimited\nwhatsapp in ENTv2 only"},"wpSubscribers":{"type":"integer","format":"int64","description":"Number of Push credits, possible value is 0 and -1 |\navailable in ENT-v2 only"}},"description":"Credit details to update","title":"CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaCredits"},"CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaFeatures":{"type":"object","properties":{"inbox":{"type":"integer","format":"int64","description":"Number of inboxes / Not required on ENTv2"},"landingPage":{"type":"integer","format":"int64","description":"Number of landing pages"},"salesUsers":{"type":"integer","format":"int64","description":"Number of sales and service users | only available in ENT-V2"},"users":{"type":"integer","format":"int64","description":"Number of multi-users"}},"description":"Features details to update","title":"CorporateSubAccountIdPlanPutRequestBodyContentApplicationJsonSchemaFeatures"},"CorporateSubAccountIdPlanPutResponsesContentApplicationJsonSchemaCode":{"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":"CorporateSubAccountIdPlanPutResponsesContentApplicationJsonSchemaCode"},"UpdateSubAccountPlanRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateSubAccountIdPlanPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateSubAccountPlanRequestBadRequestError"},"CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaCredits":{"type":"object","properties":{"email":{"type":"integer","format":"int64","description":"Number of email credits | Pass the value -1 for unlimited\nemails in ENTv2 only"},"externalFeeds":{"type":"integer","format":"int64","description":"Number of externalFeeds credits, possible values are 0 or 1\n|available in ENTv2 only"},"sms":{"type":"string","title":"float","description":"Number of SMS credits | Pass the value -1 for unlimited SMS\nin ENTv2 only"},"whatsapp":{"type":"string","title":"float","description":"Number of whatsapp credits | Pass the value -1 for unlimited\nwhatsapp in ENTv2 only"},"wpSubscribers":{"type":"integer","format":"int64","description":"Number of Push credits, possible value is 0 and -1 |\navailable in ENT-v2 only"}},"description":"Credit details to update","title":"CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaCredits"},"CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaFeatures":{"type":"object","properties":{"landingPage":{"type":"integer","format":"int64","description":"Number of landing pages"},"salesUsers":{"type":"integer","format":"int64","description":"Number of sales and service users | only available in ENT-V2"},"users":{"type":"integer","format":"int64","description":"Number of multi-users"}},"description":"Features details to update","title":"CorporateSubAccountsPlanPutRequestBodyContentApplicationJsonSchemaFeatures"},"Master account_updateSubAccountsPlan_Response_202":{"type":"object","properties":{},"description":"Empty response body","title":"Master account_updateSubAccountsPlan_Response_202"},"CorporateSubAccountsPlanPutResponsesContentApplicationJsonSchemaCode":{"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":"CorporateSubAccountsPlanPutResponsesContentApplicationJsonSchemaCode"},"UpdateSubAccountsPlanRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateSubAccountsPlanPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateSubAccountsPlanRequestBadRequestError"},"getSsoToken":{"type":"object","properties":{"token":{"type":"string","description":"Session token, it will remain valid for 15 days."}},"required":["token"],"title":"getSsoToken"},"CorporateSubAccountSsoTokenPostRequestBodyContentApplicationJsonSchemaTarget":{"type":"string","enum":["automation","email_campaign","contacts","landing_pages","email_transactional","senders","sms_campaign","sms_transactional"],"description":"**Set target after login success** * **automation** - Redirect\nto Automation after login * **email_campaign** - Redirect to\nEmail Campaign after login * **contacts** - Redirect to Contacts\nafter login * **landing_pages** - Redirect to Landing Pages\nafter login * **email_transactional** - Redirect to Email\nTransactional after login * **senders** - Redirect to Senders\nafter login * **sms_campaign** - Redirect to Sms Campaign after\nlogin * **sms_transactional** - Redirect to Sms Transactional\nafter login","title":"CorporateSubAccountSsoTokenPostRequestBodyContentApplicationJsonSchemaTarget"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfoAddress":{"type":"object","properties":{"countryCode":{"type":"string","description":"Country code"},"locality":{"type":"string","description":"Locality"},"postalCode":{"type":"string","description":"Postal code"},"stateCode":{"type":"string","description":"State code"},"streetAddress":{"type":"string","description":"Street address"}},"description":"Billing address of master account","title":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfoAddress"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfoName":{"type":"object","properties":{"familyName":{"type":"string","description":"Last name for billing"},"givenName":{"type":"string","description":"First name for billing"}},"description":"Billing name of master account holder","title":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfoName"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfo":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfoAddress","description":"Billing address of master account"},"companyName":{"type":"string","description":"Company name of master account"},"email":{"type":"string","description":"Billing email id of master account"},"name":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfoName","description":"Billing name of master account holder"}},"description":"Billing details of the master account organization","title":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfo"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the feature"},"quantity":{"type":"integer","format":"int64","description":"Quantity provided in the plan"},"quantityWithOverages":{"type":"integer","format":"int64","description":"Quantity with overages provided in the plan (only\napplicable on ENTv2)"},"remaining":{"type":"integer","format":"int64","description":"Quantity remaining in the plan"},"unitValue":{"type":"string","description":"Unit value of the feature"},"used":{"type":"integer","format":"int64","description":"Quantity consumed by master"},"usedOverages":{"type":"integer","format":"int64","description":"Quantity consumed by sub-organizations over the\nadmin plan limit (only applicable on ENTv2)"}},"title":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesItems"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfoPlanPeriod":{"type":"string","enum":["month","year"],"description":"Plan period type","title":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfoPlanPeriod"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfo":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Plan currency"},"features":{"type":"array","items":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfoFeaturesItems"},"description":"List of provided features in the plan"},"nextBillingAt":{"type":"integer","format":"int64","description":"Timestamp of next billing date"},"planPeriod":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfoPlanPeriod","description":"Plan period type"},"price":{"type":"number","format":"double","description":"Plan amount"},"subAccounts":{"type":"integer","description":"Number of sub-accounts"}},"description":"Plan details","title":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfo"},"Master account_getTheDetailsOfRequestedMasterAccount_Response_200":{"type":"object","properties":{"billingInfo":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaBillingInfo","description":"Billing details of the master account organization"},"companyName":{"type":"string","description":"Company name of master account organization"},"currencyCode":{"type":"string","description":"Currency code of the master account organization"},"email":{"type":"string","description":"Email id of master account"},"id":{"type":"integer","format":"int64","description":"Unique identifier of the master account organization"},"planInfo":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaPlanInfo","description":"Plan details"},"timezone":{"type":"string","description":"Timezone of the master account organization"}},"title":"Master account_getTheDetailsOfRequestedMasterAccount_Response_200"},"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaCode":{"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":"CorporateMasterAccountGetResponsesContentApplicationJsonSchemaCode"},"GetTheDetailsOfRequestedMasterAccountRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateMasterAccountGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetTheDetailsOfRequestedMasterAccountRequestBadRequestError"},"Master account_createAnApiKeyForASubAccount_Response_201":{"type":"object","properties":{"key":{"type":"string","description":"API key"},"status":{"type":"string","description":"Status of the API operation."}},"required":["key","status"],"title":"Master account_createAnApiKeyForASubAccount_Response_201"},"CorporateSubAccountIdApplicationsTogglePutResponsesContentApplicationJsonSchemaCode":{"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":"CorporateSubAccountIdApplicationsTogglePutResponsesContentApplicationJsonSchemaCode"},"EnableDisableSubAccountApplicationSRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateSubAccountIdApplicationsTogglePutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"EnableDisableSubAccountApplicationSRequestBadRequestError"},"Master account_createANewGroupOfSubAccounts_Response_201":{"type":"object","properties":{"id":{"type":"string"}},"title":"Master account_createANewGroupOfSubAccounts_Response_201"},"CorporateIpGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"domain":{"type":"string"},"ip":{"type":"string"},"transactional":{"type":"boolean"}},"title":"CorporateIpGetResponsesContentApplicationJsonSchemaItems"},"Master account_associateAnIpToSubAccounts_Response_201":{"type":"object","properties":{},"title":"Master account_associateAnIpToSubAccounts_Response_201"},"CorporateGroupIdGetResponsesContentApplicationJsonSchemaGroup":{"type":"object","properties":{"createdAt":{"type":"string","description":"Group creation date"},"groupName":{"type":"string","description":"Name of the group"},"id":{"type":"string","description":"Group id"}},"title":"CorporateGroupIdGetResponsesContentApplicationJsonSchemaGroup"},"CorporateGroupIdGetResponsesContentApplicationJsonSchemaSubAccountsItems":{"type":"object","properties":{"companyName":{"type":"string","description":"Name of the sub-account organzation"},"createdAt":{"type":"string","description":"Creation date of the sub-account organzation"},"id":{"type":"integer","format":"int64","description":"Id of the sub-account organzation"}},"title":"CorporateGroupIdGetResponsesContentApplicationJsonSchemaSubAccountsItems"},"CorporateGroupIdGetResponsesContentApplicationJsonSchemaUsersItems":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the user"},"firstName":{"type":"string","description":"First name of the user"},"lastName":{"type":"string","description":"Last name of the user"}},"title":"CorporateGroupIdGetResponsesContentApplicationJsonSchemaUsersItems"},"Master account_getAGroupDetails_Response_200":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/CorporateGroupIdGetResponsesContentApplicationJsonSchemaGroup"},"sub-accounts":{"type":"array","items":{"$ref":"#/components/schemas/CorporateGroupIdGetResponsesContentApplicationJsonSchemaSubAccountsItems"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/CorporateGroupIdGetResponsesContentApplicationJsonSchemaUsersItems"}}},"title":"Master account_getAGroupDetails_Response_200"},"CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItemsFeature":{"type":"string","enum":["my_plan","api","user_management","app_management","sub_organization_groups","create_sub_organizations","manage_sub_organizations","analytics","security"],"description":"Feature name","title":"CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItemsFeature"},"CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItemsPermissionsItems":{"type":"string","enum":["all","none","create","edit_delete","download_data","create_alerts"],"title":"CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItemsPermissionsItems"},"CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItems":{"type":"object","properties":{"feature":{"$ref":"#/components/schemas/CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItemsFeature","description":"Feature name"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItemsPermissionsItems"},"description":"Permissions for a given feature"}},"description":"Privileges given to the user","title":"CorporateUserInvitationSendPostRequestBodyContentApplicationJsonSchemaPrivilegesItems"},"Master account_inviteAdminUser_Response_201":{"type":"object","properties":{"id":{"type":"string"}},"title":"Master account_inviteAdminUser_Response_201"},"CorporateUserInvitationSendPostResponsesContentApplicationJsonSchemaCode":{"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":"CorporateUserInvitationSendPostResponsesContentApplicationJsonSchemaCode"},"InviteAdminUserRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateUserInvitationSendPostResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"InviteAdminUserRequestBadRequestError"},"CorporateUserInvitationActionEmailPutParametersAction":{"type":"string","enum":["resend","cancel"],"title":"CorporateUserInvitationActionEmailPutParametersAction"},"Master account_resendCancelAdminUserInvitation_Response_200":{"type":"object","properties":{"message":{"type":"string","description":"Action success message"}},"title":"Master account_resendCancelAdminUserInvitation_Response_200"},"CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess":{"type":"object","properties":{"analytics":{"type":"array","items":{"type":"string"},"description":"Analytics dashboard accessibility"},"api_keys":{"type":"array","items":{"type":"string"},"description":"Api keys accessiblity."},"apps_management":{"type":"array","items":{"type":"string"},"description":"Apps management accessiblity | Not available in\nENTv2"},"create_sub_organizations":{"type":"array","items":{"type":"string"},"description":"Authorization to create sub-organization in the\nadmin account. If the user creating the\nsub-organization, belongs to a group, the user must\nchoose a group at the sub-organization creation."},"manage_sub_organizations":{"type":"array","items":{"type":"string"},"description":"Authorization to manage and access sub-organizations\nin the admin account."},"my_plan":{"type":"array","items":{"type":"string"},"description":"My plan accessiblity."},"sub_organization_groups":{"type":"array","items":{"type":"string"},"description":"Group creation, modification or deletion\naccessibility"},"user_management":{"type":"array","items":{"type":"string"},"description":"User management accessiblity."}},"description":"Feature accessiblity given to the user. (Required only\nif status is active)","title":"CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess"},"CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsGroups":{"type":"object","properties":{"id":{"type":"string","description":"group id"},"name":{"type":"string","description":"group name"}},"description":"Admin user groups list","title":"CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsGroups"},"CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the user."},"feature_access":{"$ref":"#/components/schemas/CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess","description":"Feature accessiblity given to the user. (Required only\nif status is active)"},"groups":{"$ref":"#/components/schemas/CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsGroups","description":"Admin user groups list"},"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","groups","is_owner","status"],"title":"CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems"},"Master account_getCorporateInvitedUsersList_Response_200":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/CorporateInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems"},"description":"Get invited users list"}},"title":"Master account_getCorporateInvitedUsersList_Response_200"},"CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaFeatureAccess":{"type":"object","properties":{"analytics":{"type":"array","items":{"type":"string"},"description":"Permission on analytics"},"api_keys":{"type":"array","items":{"type":"string"},"description":"Permission on api keys"},"apps_management":{"type":"array","items":{"type":"string"},"description":"Permission on apps management"},"create_sub_organizations":{"type":"array","items":{"type":"string"},"description":"Permission on create sub-accounts"},"manage_sub_organizations":{"type":"array","items":{"type":"string"},"description":"Permission on manage sub-accounts"},"my_plan":{"type":"array","items":{"type":"string"},"description":"Permission on my plan"},"sub_organization_groups":{"type":"array","items":{"type":"string"},"description":"Permission on groups"},"user_management":{"type":"array","items":{"type":"string"},"description":"Permission on user management"}},"description":"Granular feature permissions given to the user.","title":"CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaFeatureAccess"},"CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaGroupsItems":{"type":"object","properties":{"id":{"type":"string","description":"group identifier"},"name":{"type":"string","description":"Group name"}},"description":"Groups details","title":"CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaGroupsItems"},"Master account_getCorporateUserPermission_Response_200":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the user."},"feature_access":{"$ref":"#/components/schemas/CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaFeatureAccess","description":"Granular feature permissions given to the user."},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaGroupsItems"}},"status":{"type":"string","description":"Status of the invited user."}},"required":["email","feature_access","groups","status"],"description":"Check admin user permissions","title":"Master account_getCorporateUserPermission_Response_200"},"CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode":{"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":"CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode"},"GetCorporateUserPermissionRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/CorporateUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetCorporateUserPermissionRequestBadRequestError"},"CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItemsFeature":{"type":"string","enum":["user_management","api","my_plan","apps_management","analytics","sub_organization_groups","create_sub_organizations","manage_sub_organizations","security"],"description":"feature name","title":"CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItemsFeature"},"CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItemsPermissionsItems":{"type":"string","enum":["all","none","create","edit_delete","create_alerts","download_data","my_looks","explore_create"],"title":"CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItemsPermissionsItems"},"CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItems":{"type":"object","properties":{"feature":{"$ref":"#/components/schemas/CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItemsFeature","description":"feature name"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItemsPermissionsItems"},"description":"Permission for the feature"}},"description":"Permission on features","title":"CorporateUserEmailPermissionsPutRequestBodyContentApplicationJsonSchemaPrivilegesItems"},"CorporateGroupsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"groupName":{"type":"string","description":"The name of the group of sub-accounts"},"id":{"type":"string","description":"Unique id of the group"}},"title":"CorporateGroupsGetResponsesContentApplicationJsonSchemaItems"},"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"},"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"},"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"},"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"},"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"},"OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaPrivilegesItems":{"type":"object","properties":{"feature":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}}},"required":["feature","permissions"],"title":"OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaPrivilegesItems"},"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"},"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"},"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_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"},"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"},"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"},"OrganizationUserInvitationActionEmailPutParametersAction":{"type":"string","enum":["resend","cancel"],"title":"OrganizationUserInvitationActionEmailPutParametersAction"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"ProcessesGetParametersSort":{"type":"string","enum":["asc","desc"],"default":"desc","title":"ProcessesGetParametersSort"},"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsName":{"type":"string","enum":["IMPORTUSER","SEARCH_EXPORT_USERS","TRANS-CALC","TRANS-GLOBAL-CALC","CAMPAIGN_PROCESSING","LIST_EXPORT","CONTACT_EXPORT"],"description":"Name/type of the process","title":"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsName"},"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsStatus":{"type":"string","enum":["queued","in_process","processing","completed","failed","cancelled"],"description":"Current status of the process","title":"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsStatus"},"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsInfoImport":{"type":"object","properties":{"invalid_emails":{"type":["string","null"],"description":"URL to CSV file containing invalid email addresses, or null if none"},"duplicate_contact_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate contact IDs, or null if none"},"duplicate_ext_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate external IDs, or null if none"},"duplicate_email_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate email IDs, or null if none"},"duplicate_phone_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate phone numbers, or null if none"},"duplicate_whatsapp_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate WhatsApp numbers, or null if none"},"duplicate_landline_number_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate landline numbers, or null if none"}},"description":"Import process details with URLs to CSV reports","title":"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsInfoImport"},"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsInfo":{"type":"object","properties":{"import":{"$ref":"#/components/schemas/ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsInfoImport","description":"Import process details with URLs to CSV reports"}},"description":"Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records.","title":"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsInfo"},"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier of the process"},"name":{"$ref":"#/components/schemas/ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsName","description":"Name/type of the process"},"status":{"$ref":"#/components/schemas/ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsStatus","description":"Current status of the process"},"info":{"$ref":"#/components/schemas/ProcessesGetResponsesContentApplicationJsonSchemaProcessesItemsInfo","description":"Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records."},"export_url":{"type":"string","format":"url","description":"Download URL for completed export processes (returned for SEARCH_EXPORT_USERS, SEARCH_EXPORT_USERS_API, CAMPAIGN_USER_DETAILS, and EXPORT_WEBHOOK process types)"}},"required":["id","name","status"],"title":"ProcessesGetResponsesContentApplicationJsonSchemaProcessesItems"},"Process_getProcesses_Response_200":{"type":"object","properties":{"count":{"type":"integer","format":"int64","description":"Total number of processes available on your account"},"processes":{"type":"array","items":{"$ref":"#/components/schemas/ProcessesGetResponsesContentApplicationJsonSchemaProcessesItems"},"description":"List of background processes on your account"}},"required":["count","processes"],"title":"Process_getProcesses_Response_200"},"ProcessesGetResponsesContentApplicationJsonSchemaCode":{"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":"ProcessesGetResponsesContentApplicationJsonSchemaCode"},"GetProcessesRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ProcessesGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetProcessesRequestBadRequestError"},"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaName":{"type":"string","enum":["IMPORTUSER","SEARCH_EXPORT_USERS","TRANS-CALC","TRANS-GLOBAL-CALC","CAMPAIGN_PROCESSING","LIST_EXPORT","CONTACT_EXPORT"],"description":"Name/type of the process","title":"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaName"},"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["queued","in_process","processing","completed","failed","cancelled"],"description":"Current status of the process","title":"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaStatus"},"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaInfoImport":{"type":"object","properties":{"invalid_emails":{"type":["string","null"],"description":"URL to CSV file containing invalid email addresses, or null if none"},"duplicate_contact_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate contact IDs, or null if none"},"duplicate_ext_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate external IDs, or null if none"},"duplicate_email_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate email IDs, or null if none"},"duplicate_phone_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate phone numbers, or null if none"},"duplicate_whatsapp_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate WhatsApp numbers, or null if none"},"duplicate_landline_number_id":{"type":["string","null"],"description":"URL to CSV file containing duplicate landline numbers, or null if none"}},"description":"Import process details with URLs to CSV reports","title":"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaInfoImport"},"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaInfo":{"type":"object","properties":{"import":{"$ref":"#/components/schemas/ProcessesProcessIdGetResponsesContentApplicationJsonSchemaInfoImport","description":"Import process details with URLs to CSV reports"}},"description":"Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records.","title":"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaInfo"},"Process_getProcess_Response_200":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier of the process"},"name":{"$ref":"#/components/schemas/ProcessesProcessIdGetResponsesContentApplicationJsonSchemaName","description":"Name/type of the process"},"status":{"$ref":"#/components/schemas/ProcessesProcessIdGetResponsesContentApplicationJsonSchemaStatus","description":"Current status of the process"},"info":{"$ref":"#/components/schemas/ProcessesProcessIdGetResponsesContentApplicationJsonSchemaInfo","description":"Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records."},"export_url":{"type":"string","format":"url","description":"Download URL for completed export processes (returned for SEARCH_EXPORT_USERS, SEARCH_EXPORT_USERS_API, CAMPAIGN_USER_DETAILS, and EXPORT_WEBHOOK process types)"}},"required":["id","name","status"],"title":"Process_getProcess_Response_200"},"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaCode":{"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":"ProcessesProcessIdGetResponsesContentApplicationJsonSchemaCode"},"GetProcessRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ProcessesProcessIdGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetProcessRequestBadRequestError"},"FeedsGetParametersSort":{"type":"string","enum":["asc","desc"],"default":"desc","title":"FeedsGetParametersSort"},"FeedsGetParametersAuthType":{"type":"string","enum":["basic","token","noAuth"],"title":"FeedsGetParametersAuthType"},"FeedsGetResponsesContentApplicationJsonSchemaFeedsItemsAuthType":{"type":"string","enum":["basic","token","noAuth"],"description":"Authentication type for accessing the feed","title":"FeedsGetResponsesContentApplicationJsonSchemaFeedsItemsAuthType"},"FeedsGetResponsesContentApplicationJsonSchemaFeedsItemsHeadersItems":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"required":["name","value"],"title":"FeedsGetResponsesContentApplicationJsonSchemaFeedsItemsHeadersItems"},"FeedsGetResponsesContentApplicationJsonSchemaFeedsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuidv4","description":"Unique identifier of the feed"},"name":{"type":"string","description":"Name of the feed"},"url":{"type":"string","format":"url","description":"URL of the external data source"},"authType":{"$ref":"#/components/schemas/FeedsGetResponsesContentApplicationJsonSchemaFeedsItemsAuthType","description":"Authentication type for accessing the feed"},"username":{"type":"string","description":"Username for basic authentication. Only returned when authType is 'basic'. Excluded when authType is 'token'."},"password":{"type":"string","description":"Password for basic authentication. Only returned when authType is 'basic'. Excluded when authType is 'token'."},"token":{"type":"string","description":"Token for token-based authentication. Only returned when authType is 'token'. Excluded when authType is 'basic' or 'noAuth'."},"maxRetries":{"type":"integer","description":"Maximum number of retry attempts for failed requests"},"cache":{"type":"boolean","description":"Whether to cache the feed response"},"headers":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FeedsGetResponsesContentApplicationJsonSchemaFeedsItemsHeadersItems"},"description":"Custom HTTP headers for the feed request"},"createdAt":{"type":"string","format":"date-time","description":"Feed creation timestamp"},"modifiedAt":{"type":"string","format":"date-time","description":"Feed last modification timestamp"}},"required":["id","name","url","authType","maxRetries","cache","createdAt","modifiedAt"],"title":"FeedsGetResponsesContentApplicationJsonSchemaFeedsItems"},"External Feeds_getAllExternalFeeds_Response_200":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of feeds"},"feeds":{"type":"array","items":{"$ref":"#/components/schemas/FeedsGetResponsesContentApplicationJsonSchemaFeedsItems"},"description":"List of external feeds"}},"required":["count","feeds"],"title":"External Feeds_getAllExternalFeeds_Response_200"},"FeedsGetResponsesContentApplicationJsonSchemaCode":{"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":"FeedsGetResponsesContentApplicationJsonSchemaCode"},"GetAllExternalFeedsRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetAllExternalFeedsRequestBadRequestError"},"FeedsPostRequestBodyContentApplicationJsonSchemaAuthType":{"type":"string","enum":["basic","token","noAuth"],"default":"noAuth","description":"Authentication type for accessing the feed","title":"FeedsPostRequestBodyContentApplicationJsonSchemaAuthType"},"FeedsPostRequestBodyContentApplicationJsonSchemaHeadersItems":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"required":["name","value"],"title":"FeedsPostRequestBodyContentApplicationJsonSchemaHeadersItems"},"External Feeds_createExternalFeed_Response_201":{"type":"object","properties":{"id":{"type":"string","format":"uuidv4","description":"UUID of the created feed"}},"required":["id"],"title":"External Feeds_createExternalFeed_Response_201"},"FeedsPostResponsesContentApplicationJsonSchemaCode":{"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":"FeedsPostResponsesContentApplicationJsonSchemaCode"},"CreateExternalFeedRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsPostResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"CreateExternalFeedRequestBadRequestError"},"FeedsUuidGetResponsesContentApplicationJsonSchemaAuthType":{"type":"string","enum":["basic","token","noAuth"],"description":"Authentication type for accessing the feed","title":"FeedsUuidGetResponsesContentApplicationJsonSchemaAuthType"},"FeedsUuidGetResponsesContentApplicationJsonSchemaHeadersItems":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"required":["name","value"],"title":"FeedsUuidGetResponsesContentApplicationJsonSchemaHeadersItems"},"External Feeds_getExternalFeedByUUID_Response_200":{"type":"object","properties":{"id":{"type":"string","format":"uuidv4","description":"Unique identifier of the feed"},"name":{"type":"string","description":"Name of the feed"},"url":{"type":"string","format":"url","description":"URL of the external data source"},"authType":{"$ref":"#/components/schemas/FeedsUuidGetResponsesContentApplicationJsonSchemaAuthType","description":"Authentication type for accessing the feed"},"username":{"type":["string","null"],"description":"Username for basic authentication. Only returned when authType is 'basic'. Excluded from response when authType is 'token'."},"password":{"type":["string","null"],"description":"Password for basic authentication. Only returned when authType is 'basic'. Excluded from response when authType is 'token'."},"token":{"type":["string","null"],"description":"Token for token-based authentication. Only returned when authType is 'token'. Excluded from response when authType is 'basic' or 'noAuth'."},"headers":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FeedsUuidGetResponsesContentApplicationJsonSchemaHeadersItems"},"description":"Custom HTTP headers for the feed request"},"maxRetries":{"type":"integer","description":"Maximum number of retry attempts for failed requests"},"cache":{"type":"boolean","description":"Whether to cache the feed response"},"createdAt":{"type":"string","format":"date-time","description":"Feed creation timestamp"},"modifiedAt":{"type":"string","format":"date-time","description":"Feed last modification timestamp"}},"required":["id","name","url","authType","maxRetries","cache","createdAt","modifiedAt"],"title":"External Feeds_getExternalFeedByUUID_Response_200"},"FeedsUuidGetResponsesContentApplicationJsonSchemaCode":{"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":"FeedsUuidGetResponsesContentApplicationJsonSchemaCode"},"GetExternalFeedByUUIDRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsUuidGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetExternalFeedByUUIDRequestBadRequestError"},"GetExternalFeedByUUIDRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsUuidGetResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"GetExternalFeedByUUIDRequestNotFoundError"},"FeedsUuidPutRequestBodyContentApplicationJsonSchemaAuthType":{"type":"string","enum":["basic","token","noAuth"],"description":"Authentication type for accessing the feed","title":"FeedsUuidPutRequestBodyContentApplicationJsonSchemaAuthType"},"FeedsUuidPutRequestBodyContentApplicationJsonSchemaHeadersItems":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"required":["name","value"],"title":"FeedsUuidPutRequestBodyContentApplicationJsonSchemaHeadersItems"},"FeedsUuidPutResponsesContentApplicationJsonSchemaCode":{"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":"FeedsUuidPutResponsesContentApplicationJsonSchemaCode"},"UpdateExternalFeedRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsUuidPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateExternalFeedRequestBadRequestError"},"UpdateExternalFeedRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsUuidPutResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"UpdateExternalFeedRequestNotFoundError"},"FeedsUuidDeleteResponsesContentApplicationJsonSchemaCode":{"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":"FeedsUuidDeleteResponsesContentApplicationJsonSchemaCode"},"DeleteExternalFeedRequestBadRequestError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsUuidDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteExternalFeedRequestBadRequestError"},"DeleteExternalFeedRequestNotFoundError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FeedsUuidDeleteResponsesContentApplicationJsonSchemaCode","description":"Error code displayed in case of a failure"},"message":{"type":"string","description":"Readable message associated to the failure"}},"required":["code","message"],"title":"DeleteExternalFeedRequestNotFoundError"}},"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."}}}}