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

Send multiple API calls in a single request for improved performance.

Customer.io Batch 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 Batch. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

2 operations 2 paths 3 schemas 2 POST

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 Batch 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 2

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

Batch 2

Send multiple API calls in a single request for improved performance.

POST
/batch
Send a batch of API calls
batchCalls body → 200400401
POST
../v2/batch
Batch entity operations
trackBatch body → 200400401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are EntityRequest (6 properties), BatchRequest (1 property), BatchRequest_2 (1 property). Each schema is shown below with its type and property counts.

BatchRequest_2
object
A batch of entity operations. The request must be smaller than 500KB.
1 property 1 required
EntityRequest
object
A v2 entity operation request. The type and action determine what operation is performed.
6 properties 3 required
BatchRequest
object
A batch of API calls. The request must be smaller than 1MB. Individual calls in the batch are limited to 64KB each.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customer-io-batch-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 Broadcasts API
Customer.io Campaigns API
Customer.io Collections 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