Create external feed

Creates a new external feed for dynamic content in email campaigns. **Use this to:** - Set up external data sources for dynamic content - Configure authentication for protected feeds - Enable real-time content updates in campaigns - Establish connections to product catalogs, blogs, or APIs **Key information returned:** - Created feed UUID for reference in campaigns - Success confirmation **Important considerations:** - Feed URL must be accessible from Brevo infrastructure - Authentication credentials are securely encrypted - Test feed accessibility before campaign use - Consider feed response time for campaign performance - Monitor feed reliability and uptime - Use caching for frequently accessed feeds - Maximum 5 retry attempts allowed for failed requests - Custom headers support for API integration requirements

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

External feed configuration
namestringRequired
Name of the feed
urlstringRequiredformat: "url"
URL of the external data source
authTypeenumOptionalDefaults to noAuth
Authentication type for accessing the feed
Allowed values:
usernamestringOptional

Username for basic authentication (required if authType is ‘basic’)

passwordstringOptional

Password for basic authentication (required if authType is ‘basic’)

tokenstringOptional

Token for token-based authentication (required if authType is ‘token’)

maxRetriesintegerOptional0-5Defaults to 5
Maximum number of retry attempts for failed requests
cachebooleanOptionalDefaults to false
Whether to cache the feed response
headerslist of objectsOptional
Custom HTTP headers for the feed request

Response

External feed created successfully
idstringformat: "uuidv4"
UUID of the created feed

Errors