Segments and memberships

Register external segments and push segment membership updates into Marketing.

Setup

Each integration receives endpoint URLs (including integration_id) and an access key.
At setup, the customer maps an external customer identifier field to a Bloomreach profile identifier field. Each value in customer_ids will use that mapped identifier.

Authentication

Every request must include the Bearer access key generated on integration creation (Authorization: Bearer <access_key>).

Endpoints

Rate limiting

Membership updates share a single rate limit per workspace (request frequency and customer-ID throughput). See POST …/membership-updates.

Processing

Per-customer processing failures are reported in 207 Multi-Status responses, grouped by segment_id and error code.
Handling of customer IDs with no matching Bloomreach profile depends on the integration configuration: identifiers in customer_ids are either upserted (a new profile is created and segment membership is applied) or ignored.

OpenAPI spec

Get the OpenAPI specification for this API from GitHub: