Skip to main content

Get Marketing Preferences

GET 
/client/users/:correlation_id/profile/marketing-preferences

Returns the member's marketing preferences across all configured-and-enabled channels and topics**:**

  • Emits every configured-and-enabled channel and, within each channel, every topic in that channel's MARKETING_PREFERENCES..topics config. Topics with no ESP record emit { "status": "NOT_SET" } with no lastStatusUpdateDt and no lastStatusUpdateSource.

  • Channels with enabled: false in MARKETING_PREFERENCES config are omitted entirely.

Per-topic fields (when status is OPTED_IN or OPTED_OUT****):

  • status — OPTED_IN | OPTED_OUT | NOT_SET | PENDING

  • lastStatusUpdateDt — ISO-8601 timestamp of the last status change

  • lastStatusUpdateSource — write origin of the last status change. One of:

    • CUX — CUX session write (member-initiated)

    • CONSOLE — CSR on behalf of the member

    • ESP — status changed directly on the ESP

Status codes:

  • 200 — success (full configured-topic projection, even for a brand-new member)

  • 401 — session expired / invalid correlation_id

  • 5xx PREFERENCES_PROVIDER_UNAVAILABLE — ESP timeout or provider 5xx.

Request​

Responses​

200 OK — Mixed status marketing preferences

Last updated on