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 Components Types API

The Components Types API from Extole — 3 operation(s) for components types.

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

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

This API exposes 6 operations across 3 paths, and defines 5 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.

6 operations 3 paths 5 schemas 1 DELETE3 GET1 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 Components Types 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 6

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

Components Types 6
GET
/v1/component-types
List component types
listComponentTypes 4 params → 200400401402403415429
POST
/v1/component-types
Create a component type
createComponentType body → 200400401402403415429
GET
/v1/component-types/default
List default component types
listDefaultComponentTypes 4 params → 200400401402403415429
GET
/v1/component-types/{name}
Get a component type
getComponentType 1 param → 200400401402403415429
PUT
/v1/component-types/{name}
Update a component type
updateComponentType 1 param body → 200400401402403415429
DELETE
/v1/component-types/{name}
Archive a component type
archiveComponentType 1 param → 200400401402403415429

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ComponentTypeResponse (6 properties), RestExceptionResponse (5 properties), ComponentTypeCreateRequest (4 properties), ComponentTypeUpdateRequest (1 property). Each schema is shown below with its type and property counts.

ComponentTypeUpdateRequest
object
Body of a PUT /v1/component-types/{name} request.
1 property
ComponentTypeCreateRequest
object
Body of a POST /v1/component-types request.
4 properties 2 required
ComponentTypeResponse
object
Component type definition that describes the settings schema, display metadata, and parent relationship for campaign components.
6 properties 6 required
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-components-types-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