For AI agents: visit https://documentation.bloomreach.com/engagement/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides API reference Release notes Help center

Home Engagement Other resources

API reference

Home Engagement Other resources

Guides API reference Release notes Help center

Welcome
About Engagement API
Authentication

Get started
Prerequisites
Authorization header
Making your first call
Tips and Best Practices
API FAQ

Rotate API Secretpost
Revoke API Secretpost

Tracking API overview
System timeget
Update customer propertiespost
Add eventpost
Batch commandspost

GDPR API Overview
Add consent
Customer consents
Get consent categoriesget
Anonymize a customerpost
Anonymize customers in-bulkpost

Customer API Overview
Customer attributespost
Contextual Personalization Best Variantpost
Contextual Personalization Rewardpost
Export a customerpost
Export all customerspost
Export eventspost

Get started with your API
MMS: Verify credentialsget
Email: List webhooksget
Email: Create a webhookpost
Email: Delete a webhookdel
Email: Send an emailpost
Email: Callback endpointpost
MMS: Verify credentialsget
SMS: Send SMSpost
SMS: Callback outbound endpointpost
SMS: Callback inbound endpointpost
MMS: Verify credentialsget
MMS: Send MMSpost
MMS: Callback outbound endpointpost
MMS: Callback inbound endpointpost

Analysis API Overview
Retrieve funnelspost
Retrieve reportspost
Retrieve retentionspost
Retrieve segmentationspost

Catalog API Overview
Create a catalogpost
Get all catalogsget
Get catalog nameget
Get catalog itemsget
Get a catalog itemget
Update a catalog nameput
Update a catalog itemput
Catalog item - Partial updatepost
Delete catalogdel
Delete catalog itemdel
Delete all catalog itemsdel
Bulk Update Catalog Itemput
Bulk Delete Catalog Itemsdel
Bulk Partial Update Catalog Itempost

Transactional emailpost

Transactional SMSpost

List archived messagespost
Get a single archived messagepost

Start importpost
Start exportpost

Managed Endpoints APIpost

List importsget
Create importpost
Read importget
Delete importdel

GDPR API

Customer consents

Customer consents uses a specific definition of the Customer attributes method. Read more on its separate Customer consents page.

Updated 4 months ago

Get consent categories

Did this page help you?

Updated 4 months ago

Get consent categories

Did this page help you?

© Bloomreach, Inc. All rights reserved.