The date and time which the marketing preference was last updated
{ "id": "00000000-0000-0000-0000-000000000000", "text": "I want to receive emails about special offers", "organisation_id": "00000000-0000-0000-0000-000000000000", "created_at": "2026-01-15T09:30:00+00:00", "updated_at": "2026-01-15T09:30:00+00:00"}
Optional organisation filter. When provided, only marketing
preferences belonging to the supplied organisation are returned;
omit to list preferences across every organisation the caller
has access to.
Responses
200
The marketing preferences were successfully retrieved
Optional site that this marketing preference applies to.
When set, only customers signing up at this site are
offered the opt-in; leave blank to apply the preference
across every site in the organisation.
Identifier of the organisation that owns this marketing
preference. Preferences are inherited by every site in
the organisation unless site_id narrows the scope.
Responses
201
The marketing preference was successfully retrieved
Identifier of the organisation-level marketing preference
to enable at this site. After enablement, customers
signing up at the site are offered this opt-in checkbox
alongside any preferences already enabled.
Responses
201
The marketing preference was successfully retrieved
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.