Marketing preferences

POST

/public/v1/marketing-preferences

curl --request POST \
  --url https://example.kwickbooking.com/public/v1/marketing-preferences \
  --header 'Content-Type: application/json' \
  --header 'X-KB-Publishable-Key: <X-KB-Publishable-Key>' \
  --data '{ "contactId": "01920000-0000-7000-8000-000000000012", "emailMarketing": true, "smsMarketing": false, "profilingForAnalytics": null }'

• Your deployment

Records a guest’s choice about marketing by email and text, with the wording they agreed to. Send an Idempotency-Key header.

Authorizations

• PublishableKey

Request Body^required

Media typeapplication/json

A contact’s marketing choices: email and text marketing, and optionally consent to profiling for analytics. Each is recorded as consent with the wording agreed to.

object

contactId

required

string format: uuid

emailMarketing

required

boolean

smsMarketing

required

boolean

profilingForAnalytics

null | boolean

Example

{
  "contactId": "01920000-0000-7000-8000-000000000012",
  "emailMarketing": true,
  "smsMarketing": false,
  "profilingForAnalytics": null
}

Responses

200

OK

Media typeapplication/json

Marketing-preferences update outcome.

object

contactId

required

string format: uuid

emailMarketing

required

boolean

smsMarketing

required

boolean

Example

{
  "contactId": "01920000-0000-7000-8000-000000000012",
  "emailMarketing": true,
  "smsMarketing": false
}

400

Validation failed (https://developers.kwickblocks.ai/problems/validation-failed); Idempotency-Key required (https://developers.kwickblocks.ai/problems/idempotency-key-required)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Validation failed

{
  "type": "https://developers.kwickblocks.ai/problems/validation-failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "Some of the details weren't valid. Please check them and try again."
}

Idempotency-Key required

{
  "type": "https://developers.kwickblocks.ai/problems/idempotency-key-required",
  "title": "Idempotency-Key required",
  "status": 400,
  "detail": "This request needs an Idempotency-Key header."
}

401

Invalid or missing integration key (https://developers.kwickblocks.ai/problems/invalid-key)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Exampleinvalid-key

Invalid or missing integration key

{
  "type": "https://developers.kwickblocks.ai/problems/invalid-key",
  "title": "Invalid or missing integration key",
  "status": 401,
  "detail": "This integration key isn't valid. Ask the venue's admin for a new one."
}

404

Not found (https://developers.kwickblocks.ai/problems/not-found)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Examplenot-found

Not found

{
  "type": "https://developers.kwickblocks.ai/problems/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "I couldn't find that."
}

409

Idempotency-Key conflict (https://developers.kwickblocks.ai/problems/idempotency-conflict)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Exampleidempotency-conflict

Idempotency-Key conflict

{
  "type": "https://developers.kwickblocks.ai/problems/idempotency-conflict",
  "title": "Idempotency-Key conflict",
  "status": 409,
  "detail": "That Idempotency-Key was already used for a different request."
}

429

Too many requests (https://developers.kwickblocks.ai/problems/rate-limited)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Examplerate-limited

Too many requests

{
  "type": "https://developers.kwickblocks.ai/problems/rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "There have been too many requests. Please try again in a minute."
}