Skip to main content
POST
Assign a consumer to a segment.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
required

Path Parameters

consumer_id
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"consumer-12345"

segment_reference
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_.-]*$

Response

Successful Response

associated_at
string<date-time>
required

When the consumer was assigned to the segment.

Example:

"2026-07-10T08:00:00Z"

reference
string
required

Public reference (slug) of the segment the consumer is assigned to.

Example:

"high-value-shoppers"