Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Email API

The Email API from Extole — 7 operation(s) for email.

Extole Email API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Email. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 7 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

10 operations 7 paths 14 schemas 1 DELETE4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Email API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 10

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

Email 10
GET
/api/v4/me/email/status/{polling_id}deprecated
Get email send status
getSendEmailStatus 1 param → 200400401403415429
POST
/api/v4/me/emaildeprecated
Send an email as the authenticated consumer
sendEmail body → 200400401403415429
POST
/v4/email-domains/{emailDomainId}/generate-dkim-records
Generate DKIM records
generateEmailDomainDkimRecords 1 param → 200400401402403415429
POST
/v4/email/validate
Validate an email address
validateEmail body → 200400401403415429
GET
/v4/email-domains
List email domains
listEmailDomains → 200400401402403415429
POST
/v4/email-domains
Create an email domain
createEmailDomain body → 200400401402403415429
GET
/v4/email-domains/{emailDomainId}
Get an email domain
getEmailDomain 1 param → 200400401402403415429
PUT
/v4/email-domains/{emailDomainId}
Update an email domain
updateEmailDomain 1 param body → 200400401402403415429
DELETE
/v4/email-domains/{emailDomainId}
Delete an email domain
deleteEmailDomain 1 param → 200400401402403415429
GET
/v4/email-domains/{emailDomainId}/validate
Validate an email domain
validateEmailDomain 1 param → 200400401402403415429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EmailDomainValidationResponse (7 properties), SendEmailPollingResponse (5 properties), SendEmailError (5 properties), RestExceptionResponse (5 properties). Each schema is shown below with its type and property counts.

EmailDomainCreateRequest
object
Body of a POST /v4/email-domains request.
3 properties 1 required
DkimRecordsResponse
object
1 property 1 required
SendEmailError
object
5 properties
EmailProviderValidationRequest
object
1 property 1 required
DnsRecordVerificationResponse
object
3 properties
SendEmailRequest
object
2 properties 2 required
EmailDomainValidationResponse
object
7 properties 7 required
EmailProviderValidationResponse
object
2 properties 2 required
SendEmailResponse
object
1 property 1 required
SendEmailPollingResponse
object
5 properties 5 required
EmailDomainResponse
object
4 properties 4 required
EmailDomainUpdateRequest
object
Body of a PUT /v4/email-domains/{emailDomainId} request.
3 properties
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
CnameRecord
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-email-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API