Marketing · Trybe API

post/shop/email-lists

Create an email list from shop criteria

createEmailList

Builds an auto-populated email list in the Customer API from criteria evaluated against the Shop API. The intended use case is one-shot mailshots: select an order filter or session attendance in the operator UI and have the matching customers piped into a Mailchimp-compatible list without manual export.

The criteria type determines which selector fields are required — order_filters expects the filters object, session_attendees expects session_id, and so on.

Request body

namestringrequired
The display name of the email list.
criteria_typestringrequired
Which selector the list is populated from. Determines which of the optional fields below must be supplied.
Possible values:order_filterssession_attendees
filtersobjectoptional
For criteria_type: order_filters, the order filters applied — same shape as the order-list query parameters.
session_idstringoptional
For criteria_type: session_attendees, the session whose attendees should be added to the list.
site_idstringoptional
The site the email list belongs to.

Responses

200
The email list was successfully created.
400
The request failed.
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/email-lists" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "January orders",
  "criteria_type": "order_filters",
  "filters": {},
  "session_id": "5dcb47800000000000000000",
  "site_id": "00000000-0000-0000-0000-111111111111"
}'

const response = await fetch('https://api.playground.try.be/shop/email-lists', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "January orders",
    "criteria_type": "order_filters",
    "filters": {},
    "session_id": "5dcb47800000000000000000",
    "site_id": "00000000-0000-0000-0000-111111111111"
  }),
})

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/email-lists",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "January orders",
        "criteria_type": "order_filters",
        "filters": {

        },
        "session_id": "5dcb47800000000000000000",
        "site_id": "00000000-0000-0000-0000-111111111111"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/email-lists', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'January orders',
            'criteria_type' => 'order_filters',
            'filters' => [

            ],
            'session_id' => '5dcb47800000000000000000',
            'site_id' => '00000000-0000-0000-0000-111111111111'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "January orders",
		"criteria_type": "order_filters",
		"filters": map[string]interface{}{

		},
		"session_id": "5dcb47800000000000000000",
		"site_id": "00000000-0000-0000-0000-111111111111",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/email-lists", 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 email list was successfully created.

{
  "data": {
    "id": "00000000-0000-0000-0000-111111111111",
    "name": "January orders"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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