Segments | Orishare docs

List segments

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Response Body

`application/json`

curl -X GET "https://example.com/segments"

{  "data": [    {      "id": "string",      "name": "string",      "kind": "static",      "definition": null,      "members": 0,      "version": 0,      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Create a static or dynamic (customer.attributes.*) segment

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Match^[a-z][a-z0-9_]{0,59}$

kind*string

Value in

"static"
"dynamic"

definition?unknown

Any JSON value (object, array, string, number, boolean or null). Kept non-recursive in the OpenAPI document.

Response Body

`application/json`

curl -X POST "https://example.com/segments" \  -H "Content-Type: application/json" \  -d '{    "name": "vip",    "kind": "static"  }'

{  "id": "string",  "name": "string",  "kind": "static",  "definition": null,  "members": 0,  "version": 0,  "created_at": "string",  "updated_at": "string"}

One segment by id or name

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/segments/string"

{  "id": "string",  "name": "string",  "kind": "static",  "definition": null,  "members": 0,  "version": 0,  "created_at": "string",  "updated_at": "string"}

Rename (when unreferenced) or change a dynamic definition

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Match^[a-z][a-z0-9_]{0,59}$

definition?unknown

Any JSON value (object, array, string, number, boolean or null). Kept non-recursive in the OpenAPI document.

Response Body

`application/json`

curl -X PATCH "https://example.com/segments/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "kind": "static",  "definition": null,  "members": 0,  "version": 0,  "created_at": "string",  "updated_at": "string"}

Delete an unreferenced segment

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/segments/string"

Empty

Static members

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/segments/string/members"

{  "data": [    {      "segment_id": "string",      "customer_id": "string",      "created_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Add static members (idempotent, up to 500 per call)

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customer_ids*array<>

Items1 <= items <= 500

Response Body

`application/json`

curl -X POST "https://example.com/segments/string/members" \  -H "Content-Type: application/json" \  -d '{    "customer_ids": [      "string"    ]  }'

{  "added": 0,  "memberships": [    {      "segment_id": "string",      "customer_id": "string",      "created_at": "string"    }  ]}

Remove a static member

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

customer_id*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/segments/string/members/string"

Empty

Is this customer in the segment right now (dynamic ones evaluate live)

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

customer_id*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/segments/string/eligibility/string"

{  "segment": "string",  "customer_id": "string",  "eligible": true,  "kind": "static",  "operands": null}

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`