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 Settings API

The Settings API from Extole — 5 operation(s) for settings.

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

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

This API exposes 10 operations across 5 paths, and defines 9 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 5 paths 9 schemas 2 DELETE5 GET2 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 Settings 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 5 paths, the API surfaces 10 operations — 2 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 10
GET
/v2/me/clients
List accessible clients
listMeClients → 200400401402403415429
GET
/v2/logo
Get the client logo
getLogo → 200400401402403415429
POST
/v2/logo
Upload a client logo
createLogo body → 200400401402403415429
DELETE
/v2/logo
Archive the client logo
archiveLogo → 200400401402403415429
GET
/v2/logo/image
Download logo image
downloadLogoImage → 200400401402403415429
GET
/v2/timeline-entries
List timeline entries
listTimelineEntries 1 param → 200400401402403415429
POST
/v2/timeline-entries
Create a timeline entry
createTimelineEntry body → 200400401402403415429
GET
/v2/timeline-entries/{name}
Get a timeline entry
getTimelineEntry 1 param → 200400401402403415429
PUT
/v2/timeline-entries/{name}
Update a timeline entry
updateTimelineEntry 1 param body → 200400401402403415429
DELETE
/v2/timeline-entries/{name}
Delete a timeline entry
deleteTimelineEntry 1 param → 200400401402403415429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ClientTimelineEntryResponse (5 properties), RestExceptionResponse (5 properties), UpdateClientTimelineEntryRequest (4 properties), ClientTimelineEntryRequest (4 properties). Each schema is shown below with its type and property counts.

MeClientResponse
object
2 properties 2 required
LogoResponse
object
3 properties 3 required
FileInputStreamRequest
object
2 properties 2 required
ClientTimelineEntryRequest
object
4 properties 4 required
ClientTimelineEntryResponse
object
5 properties 5 required
UpdateClientTimelineEntryRequest
object
4 properties 4 required
FileAttributes
object
2 properties
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-settings-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