MarketingPreferences

List public marketing preferences for an organisation

Returns the marketing preferences (e.g. "email me about offers") that an organisation has defined for public display on unauthenticated signup flows. The response is a stripped-down projection — only the preference ID and display text — so the payload is safe to expose on a public webpage.

Use this to populate the consent checkboxes on a guest-facing signup form before the customer has any login credentials. Once the customer registers, switch to listCustomerMarketingPreferences to read or update their personal opt-in state.

This endpoint is public — no authentication is required.

get/customers/show-marketing-preferences

Query parameters

organisation_idstring uuid required

The organisation whose public marketing preferences to return. Required — public callers must scope the lookup to a specific organisation.

Response

The public marketing preferences were successfully retrieved.

Example response

{
  "data": [
    {
      "text": "I want to receive emails about special offers"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.