How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dotdigital Data Firehose API

The Data Firehose API from Dotdigital — 3 operation(s) for data firehose.

Dotdigital Data Firehose API is one of 63 APIs that Dotdigital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Firehose. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 3.0.1.

Requests are made against a single base URL, https://{region}-api.dotdigital.com.

5 operations 3 paths 26 schemas 1 DELETE1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.1
Base URL
https://r1-api.dotdigital.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Dotdigital Data Firehose API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Data Firehose 5
GET
/data-firehose/v3/configurations/{id}
Get configuration
getConfiguration 1 param → 200400401403404
PUT
/data-firehose/v3/configurations/{id}
Update configuration
updateConfiguration 2 params body → 200400401403404
DELETE
/data-firehose/v3/configurations/{id}
Delete configuration
deleteConfiguration 1 param → 204400401403404409
PUT
/data-firehose/v3/configurations/{id}/status/{newStatus}
Update configuration status
updateStatus 3 params → 204401403404
POST
/data-firehose/v3/configurations
Add configuration
addConfiguration body → 201400401403

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are googleCloudStorage_authentication (11 properties), amazonS3sas_configuration (4 properties), sftpPassword_configuration (4 properties), azureBlobOauth_authentication (4 properties). Each schema is shown below with its type and property counts.

sftpPrivateKey
object
Amazon S3 storage
3 properties 3 required
sftpPassword_configuration
object
The configuration parameters for the storage.
4 properties 4 required
smsFailedEvent
object
2 properties 1 required
googleCloudStorage_configuration
object
The configuration parameters for the storage.
3 properties 3 required
googleCloudStorage_authentication
object
The authentication details for the platform
11 properties 11 required
errorResponse_details
object
2 properties 2 required
sftpPrivateKey_authentication
object
The authentication details for the platform
3 properties 3 required
azureBlobSas_authentication
object
The authentication details for the platform
2 properties 2 required
azureBlobSas
object
Amazon S3 storage
3 properties 3 required
googleCloudStorage
object
Amazon S3 storage
3 properties 3 required
azureBlobOauth_authentication
object
The authentication details for the platform
4 properties 4 required
azureBlobOauth_configuration
object
The configuration parameters for the storage.
4 properties 4 required
ftpsPassword_authentication
object
The authentication details for the platform
3 properties 3 required
ftpsPassword_configuration
object
The configuration parameters for the storage.
4 properties 4 required
fireshoseConfigurationRequest
object
A configuration for Data Firehose.
4 properties 4 required
ftpsPassword
object
Amazon S3 storage
3 properties 3 required
azureBlobOauth
object
Amazon S3 storage
3 properties 3 required
sftpPassword
object
Amazon S3 storage
3 properties 3 required
amazonS3sas_configuration
object
The configuration parameters for the storage.
4 properties 4 required
errorResponse
object
3 properties 2 required
unfilteredEvents
object
1 property 1 required
fireshoseConfiguration
amazonS3sas
object
Amazon S3 storage
3 properties 3 required
transactionalEmailFailedEvent
object
2 properties 1 required
emailFailedEvent
object
2 properties 1 required
amazonS3sas_authentication
object
The authentication details for the platform
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-data-firehose-api-openapi.yml Raw ↑

Other APIs Dotdigital publishes across the network.

Dotdigital Marketing Developer Hub MCP Server
Dotdigital Accounts and Utilities API
Dotdigital API Account API
Dotdigital API Address Book API
Dotdigital API Campaign API
Dotdigital API Campaign From Address API
Dotdigital API Campaign Reporting API
Dotdigital API Campaign Send API
Dotdigital API Contact API
Dotdigital API Contact Import API
Dotdigital API Data Field API
Dotdigital API Document API
Where this information came from

This is an independent, third-party profile of Dotdigital Data Firehose API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.