A valid request URL is required to generate request examples{
"segments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {
"groups": [
{
"conditions": [
{
"source": "attribute",
"field": "email_verified",
"operator": "is_true"
}
]
},
{
"conditions": [
{
"source": "event",
"operator": "not_occurred",
"value": "checkout.paid",
"days": 30
}
]
}
]
},
"definition_version": 123,
"members": 123,
"archived_at": "2023-11-07T05:31:56Z",
"system_key": "<string>",
"system": true,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List segments
Requires customers:read. The environment’s live segments, newest first. members is how many contacts were in it as of the last refresh — the materialized count, not a recomputation; ask /preview for the number as of now.
Archived segments are not listed. They keep resolving by id, because whatever already names one has to be able to say what it was sent to.
A valid request URL is required to generate request examples{
"segments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {
"groups": [
{
"conditions": [
{
"source": "attribute",
"field": "email_verified",
"operator": "is_true"
}
]
},
{
"conditions": [
{
"source": "event",
"operator": "not_occurred",
"value": "checkout.paid",
"days": 30
}
]
}
]
},
"definition_version": 123,
"members": 123,
"archived_at": "2023-11-07T05:31:56Z",
"system_key": "<string>",
"system": true,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de consulta
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Resposta
The segments.
Show child attributes
Show child attributes