Customers

Customer Segment Members

A CustomerSegmentMember is the association between a Customer and a CustomerSegment. It tracks whether the customer is currently subscribed to receive communications for that segment.

The CustomerSegmentMember object

Attributes

iduuidrequired
The unique identifier of the segment membership record.
segment_iduuidrequired
The ID of the segment this membership belongs to.
unsubscribed_atdate-timerequirednullable
The datetime at which the customer unsubscribed from this segment's communications, or null if they are currently subscribed.
customerobjectrequired
A summary of the Customer this order belongs to.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "segment_id": "00000000-0000-0000-0000-000000000000",
  "unsubscribed_at": "2026-01-15T09:30:00+00:00",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "email": "guest@example.com",
    "first_name": "Alex",
    "full_name": "Alex Morgan",
    "labels": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "color": "#FF0066",
        "name": "Alex Morgan"
      }
    ],
    "last_name": "Morgan",
    "phone": "+447700900000"
  }
}

get/shop/customers/customer-segments/{customerSegmentId}/members

List CustomerSegmentMembers

listCustomerSegmentMembers

Returns a paginated list of members belonging to the given CustomerSegment.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.

Query parameters

querystringoptional
Filters members whose customer name or email contains the given value.
subscribedbooleanoptional
When true, only subscribed members are returned. When false, only unsubscribed members are returned.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The segment members were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members', {
  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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members",
    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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members', [
    '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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members", 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 segment members were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "segment_id": "00000000-0000-0000-0000-000000000000",
      "unsubscribed_at": "2026-01-15T09:30:00+00:00",
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "janedoe@example.com",
        "first_name": "Jane",
        "full_name": "Jane Doe",
        "labels": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "color": "#FF0066",
            "name": "Alex Morgan"
          }
        ],
        "last_name": "Doe",
        "phone": "+447900000000"
      }
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

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

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

post/shop/customers/customer-segments/{customerSegmentId}/members

Add CustomerSegmentMember

createCustomerSegmentMember

Adds a customer to the given CustomerSegment.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.

Request body

customer_iduuidrequired
The ID of the customer to add to the segment.

Responses

201
The segment member 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 POST "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "00000000-0000-0000-0000-000000000000"
}'

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "customer_id": "00000000-0000-0000-0000-000000000000"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "customer_id": "00000000-0000-0000-0000-000000000000"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'customer_id' => '00000000-0000-0000-0000-000000000000'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"customer_id": "00000000-0000-0000-0000-000000000000",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 segment member was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "segment_id": "00000000-0000-0000-0000-000000000000",
    "unsubscribed_at": "2026-01-15T09:30:00+00:00",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "janedoe@example.com",
      "first_name": "Jane",
      "full_name": "Jane Doe",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "color": "#FF0066",
          "name": "Alex Morgan"
        }
      ],
      "last_name": "Doe",
      "phone": "+447900000000"
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

get/shop/customers/customer-segments/{customerSegmentId}/members/{memberId}

Get CustomerSegmentMember

getCustomerSegmentMember

Returns the CustomerSegmentMember with the given ID.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.
memberIduuidrequired
The unique identifier of the segment membership record.

Responses

200
The segment member was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', {
  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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000",
    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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', [
    '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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000", 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 segment member was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "segment_id": "00000000-0000-0000-0000-000000000000",
    "unsubscribed_at": "2026-01-15T09:30:00+00:00",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "janedoe@example.com",
      "first_name": "Jane",
      "full_name": "Jane Doe",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "color": "#FF0066",
          "name": "Alex Morgan"
        }
      ],
      "last_name": "Doe",
      "phone": "+447900000000"
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

put/shop/customers/customer-segments/{customerSegmentId}/members/{memberId}

Update CustomerSegmentMember

updateCustomerSegmentMember

Updates the subscription state of the given segment member.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.
memberIduuidrequired
The unique identifier of the segment membership record.

Request body

subscribedbooleanoptional
Set to true to re-subscribe the customer to this segment's communications, or false to unsubscribe them.

Responses

200
The segment member 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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "subscribed": false
}'

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "subscribed": false
  }),
})

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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "subscribed": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'subscribed' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"subscribed": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 segment member was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "segment_id": "00000000-0000-0000-0000-000000000000",
    "unsubscribed_at": "2026-01-15T09:30:00+00:00",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "janedoe@example.com",
      "first_name": "Jane",
      "full_name": "Jane Doe",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "color": "#FF0066",
          "name": "Alex Morgan"
        }
      ],
      "last_name": "Doe",
      "phone": "+447900000000"
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

delete/shop/customers/customer-segments/{customerSegmentId}/members/{memberId}

Remove CustomerSegmentMember

deleteCustomerSegmentMember

Removes a customer from the given CustomerSegment.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.
memberIduuidrequired
The unique identifier of the segment membership record.

Responses

204
The customer was successfully removed from the segment.
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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', {
  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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000",
    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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', [
    '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/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000", 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 successfully removed from the segment.

// empty response

{
  "message": "Unauthenticated"
}

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

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