Customers

Customer Segments

A CustomerSegment is a named group of customers within a site that can be targeted for marketing campaigns. Segments may have optional filters based on labels or memberships to drive automatic membership.

The CustomerSegment object

Attributes

iduuidrequired
The unique identifier of the customer segment.
namestringrequired
The display name of the segment.
site_iduuidrequired
The ID of the site this segment belongs to.
filtersobjectrequirednullable
Optional filters that define automatic membership criteria for this segment. null indicates no filters are applied.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Premium Members",
  "site_id": "00000000-0000-0000-0000-000000000000",
  "filters": {
    "all_customers": false,
    "label_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}

get/shop/customers/customer-segments

List CustomerSegments

listCustomerSegments

Returns a paginated list of CustomerSegments for the given site.

Query parameters

site_iduuidrequired
Filters segments that belong to the given site ID.
querystringoptional
Filters segments whose name contains the given value.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The customer segments were successfully retrieved.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/customers/customer-segments?site_id=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?site_id=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?site_id=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?site_id=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?site_id=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 segments were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Premium Members",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "filters": {
        "all_customers": false,
        "label_ids": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "membership_type_ids": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    }
  ],
  "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"
}

post/shop/customers/customer-segments

Create CustomerSegment

createCustomerSegment

Creates a new CustomerSegment for the given site.

Request body

namestringrequired
The display name of the segment.
site_iduuidrequired
The ID of the site this segment belongs to.
filtersobjectoptionalnullable
Optional filters that define automatic membership criteria for the segment.

Responses

201
The customer segment was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/customers/customer-segments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Premium Members",
  "site_id": "00000000-0000-0000-0000-000000000000",
  "filters": {
    "all_customers": false,
    "label_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}'

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Premium Members",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "filters": {
      "all_customers": false,
      "label_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "membership_type_ids": [
        "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",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Premium Members",
        "site_id": "00000000-0000-0000-0000-000000000000",
        "filters": {
            "all_customers": False,
            "label_ids": [
                "00000000-0000-0000-0000-000000000000"
            ],
            "membership_type_ids": [
                "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', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Premium Members',
            'site_id' => '00000000-0000-0000-0000-000000000000',
            'filters' => [
                'all_customers' => false,
                'label_ids' => [
                    '00000000-0000-0000-0000-000000000000'
                ],
                'membership_type_ids' => [
                    '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{}{
		"name": "Premium Members",
		"site_id": "00000000-0000-0000-0000-000000000000",
		"filters": map[string]interface{}{
			"all_customers": false,
			"label_ids": []interface{}{
				"00000000-0000-0000-0000-000000000000",
			},
			"membership_type_ids": []interface{}{
				"00000000-0000-0000-0000-000000000000",
			},
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/customers/customer-segments", 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 customer segment was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Premium Members",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "filters": {
      "all_customers": false,
      "label_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "membership_type_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

Get CustomerSegment

getCustomerSegment

Returns the CustomerSegment with the given ID.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.

Responses

200
The customer segment 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" \
  -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', {
  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",
    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', [
    '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", 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 segment was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Premium Members",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "filters": {
      "all_customers": false,
      "label_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "membership_type_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

Update CustomerSegment

updateCustomerSegment

Updates the given CustomerSegment.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.

Request body

namestringoptional
The display name of the segment.
filtersobjectoptionalnullable
Filters that define automatic membership criteria for the segment.

Responses

200
The customer segment 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" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Premium Members",
  "filters": {
    "all_customers": false,
    "label_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}'

const response = await fetch('https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Premium Members",
    "filters": {
      "all_customers": false,
      "label_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "membership_type_ids": [
        "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.put(
    "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Premium Members",
        "filters": {
            "all_customers": False,
            "label_ids": [
                "00000000-0000-0000-0000-000000000000"
            ],
            "membership_type_ids": [
                "00000000-0000-0000-0000-000000000000"
            ]
        }
    },
)
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', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Premium Members',
            'filters' => [
                'all_customers' => false,
                'label_ids' => [
                    '00000000-0000-0000-0000-000000000000'
                ],
                'membership_type_ids' => [
                    '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{}{
		"name": "Premium Members",
		"filters": map[string]interface{}{
			"all_customers": false,
			"label_ids": []interface{}{
				"00000000-0000-0000-0000-000000000000",
			},
			"membership_type_ids": []interface{}{
				"00000000-0000-0000-0000-000000000000",
			},
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/customers/customer-segments/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 customer segment was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Premium Members",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "filters": {
      "all_customers": false,
      "label_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "membership_type_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  }
}

{
  "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}

Delete CustomerSegment

deleteCustomerSegment

Soft-deletes the given CustomerSegment. Existing segment members are unaffected, but the segment can no longer be used for campaigns. Use the companion restoreCustomerSegment endpoint to undo.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.

Responses

204
The CustomerSegment was successfully soft-deleted.
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" \
  -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', {
  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",
    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', [
    '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", 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 `CustomerSegment` was successfully soft-deleted.

// empty response

{
  "message": "Unauthenticated"
}

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

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

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

Restore CustomerSegment

restoreCustomerSegment

Restores a soft-deleted CustomerSegment so it can once again be used for campaigns. Partner to deleteCustomerSegment.

Path parameters

customerSegmentIduuidrequired
The unique identifier of the customer segment.

Responses

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

curl -X POST "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/restore" \
  -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/restore', {
  method: 'POST',
  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.post(
    "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/restore",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
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/restore', [
    '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("POST", "https://api.playground.try.be/shop/customers/customer-segments/00000000-0000-0000-0000-000000000000/restore", 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 segment was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Premium Members",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "filters": {
      "all_customers": false,
      "label_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "membership_type_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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