Customers

Customer Marketing Preferences

Endpoints for managing a Customer's opt-in/out state against each of their organisation's MarketingPreferences.

get/customers/customers/{customerId}/marketing-preferences

List a Customer's Marketing Preferences

listCustomerMarketingPreferences

Returns the marketing preferences that exist in the customer's organisation along with the customer's opt-in state for each.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Query parameters

per_pageintegeroptional
The number of results to return per page
pageintegeroptional
The page to retrieve results from

Responses

200
The customer's marketing preferences were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's marketing preferences were successfully retrieved

{
  "data": [
    {
      "id": "5dcb47800000000000000110",
      "marketing_preference": {
        "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"
      },
      "opted_in": true,
      "opted_in_at": "2020-02-24T12:00:00+00:00",
      "opted_out_at": "2020-02-24T12:00:00+00:00",
      "is_archived": true
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

get/customers/customers/{customerId}/marketing-preferences/{marketingPreferenceId}

Get a Customer's Marketing Preference

getCustomerMarketingPreference

Returns the customer's opt-in state for the given marketing preference. If the customer has never been presented with the preference, the response describes the implicit opted-out state (the preference's id with opted_in: false) rather than 404ing.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
marketingPreferenceIdstringrequired
The unique identifier of the marketing preference this operation is scoped to.

Responses

200
The customer's marketing preference state was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's marketing preference state was successfully retrieved

{
  "data": {
    "id": "5dcb47800000000000000110",
    "marketing_preference": {
      "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"
    },
    "opted_in": true,
    "opted_in_at": "2020-02-24T12:00:00+00:00",
    "opted_out_at": "2020-02-24T12:00:00+00:00",
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/customers/customers/{customerId}/marketing-preferences/{marketingPreferenceId}

Opt a Customer into a Marketing Preference

actionMarketingPreferenceOptIn

Opts the customer into the given marketing preference.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
marketingPreferenceIdstringrequired
The unique identifier of the marketing preference this operation is scoped to.

Responses

200
The customer's marketing preference state was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's marketing preference state was successfully retrieved

{
  "data": {
    "id": "5dcb47800000000000000110",
    "marketing_preference": {
      "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"
    },
    "opted_in": true,
    "opted_in_at": "2020-02-24T12:00:00+00:00",
    "opted_out_at": "2020-02-24T12:00:00+00:00",
    "is_archived": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/customers/customers/{customerId}/marketing-preferences/{marketingPreferenceId}

Opt a Customer out of a Marketing Preference

actionMarketingPreferenceOptOut

Opts the customer out of the given marketing preference.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
marketingPreferenceIdstringrequired
The unique identifier of the marketing preference this operation is scoped to.

Responses

204
The customer was opted out of the marketing preference
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/marketing-preferences/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer was opted out of the marketing preference

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}