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

contentstack Audiences API

Audiences are defined segments of users grouped by demographic, behavioral, or other attribute-based criteria for targeted content experiences.

contentstack Audiences API is one of 45 APIs that contentstack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 3 base URLs: https://api.contentstack.io, https://eu-api.contentstack.com, https://au-api.contentstack.com.

4 operations 2 paths 4 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://cdn.contentstack.io
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

contentstack Audiences API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as authtoken (authtokenAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token (M2M) with analytics access.
  • authtokenAuth — Contentstack user authtoken. Only organization Owners and Admins can access analytics.

Paths & Operations 4

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

Audiences 4

Audiences are defined segments of users grouped by demographic, behavioral, or other attribute-based criteria for targeted content experiences.

GET
/audiences
Get all audiences
getAllAudiences 1 param → 200401
POST
/audiences
Create an audience
createAudience 1 param body → 201400401
PUT
/audiences/{id}
Update an audience
updateAudience 2 params body → 200400401404
DELETE
/audiences/{id}
Delete an audience
deleteAudience 2 params → 200401404

Schemas 4

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

CreateAudienceRequest
object
Parameters for creating or updating an audience.
3 properties 1 required
Audience
object
An audience segment based on attribute rules and user behaviors.
5 properties
AudienceList
object
A list of audience segment definitions.
1 property
Error
object
Standard error response.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

contentstack-audiences-api-openapi.yml Raw ↑

Other APIs contentstack publishes across the network.

Contentstack GraphQL Content Delivery API
Contentstack Image Delivery API
Contentstack Analytics API
Contentstack Knowledge Vault API
Contentstack Generative AI API
contentstack Accounts API
contentstack Assets API
contentstack Attributes API
contentstack Audit Logs API
contentstack Automations API
contentstack Brand Kits API
contentstack Cache Analytics API