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

Customer.io Collections API

Manage collections of data used in message personalization.

Customer.io Collections API is one of 23 APIs that Customer.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collections. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.customer.io/v1, https://api-eu.customer.io/v1.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://track.customer.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Customer.io Collections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using your App API key. Pass the key in the Authorization header as Bearer {appapikey}.

Paths & Operations 5

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

Collections 5

Manage collections of data used in message personalization.

GET
/api/collections
List collections
listCollections → 200401
POST
/api/collections
Create a collection
createCollection body → 200400401
GET
/api/collections/{collection_id}
Get a collection
getCollection 1 param → 200401404
PUT
/api/collections/{collection_id}
Update a collection
updateCollection 1 param body → 200400401404
DELETE
/api/collections/{collection_id}
Delete a collection
deleteCollection 1 param → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Collection (5 properties), CreateCollectionRequest (3 properties). Each schema is shown below with its type and property counts.

CreateCollectionRequest
object
A request to create or update a data collection.
3 properties 2 required
Collection
object
A data collection used in message personalization.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customer-io-collections-api-openapi.yml Raw ↑

Other APIs Customer.io publishes across the network.

Customer.io Track API
Customer.io Activities API
Customer.io Alias API
Customer.io Batch API
Customer.io Broadcasts API
Customer.io Campaigns API
Customer.io Customers API
Customer.io Devices API
Customer.io Entity API
Customer.io Events API
Customer.io Exports API
Customer.io Group API