Segments

Endpoint

List segments

GET

https://api.preo.dev

/v1/segments

Manage customer segments with CEL-based conditions.

List segments › query Parameters

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

pass_push

sms

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

marketing

transactional

edition_id

string

ordering

string[] · style: form

Ordering

created - Created
-created - Created (descending)
modified - Modified
-modified - Modified (descending)
name - Name
-name - Name (descending)
user_count - User count
-user_count - User count (descending)
last_calculated - Last calculated
-last_calculated - Last calculated (descending)

Enum values:

-created

-last_calculated

-modified

-name

-user_count

created

last_calculated

modified

organization_id

string

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page (default: 100).

search

string

Search by segment name

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

completed

draft

failed

pending

processing

List segments › Responses

200

count

integer · required

object[] · required

next

string · uri

previous

string · uri

Create segment

POST

https://api.preo.dev

/v1/segments

Manage customer segments with CEL-based conditions.

Create segment › Request Body

organization_id

string · required

name

string · maxLength: 255 · required

Human-readable segment name

edition_id

string | null

consent_id

string | null

description

string

Optional description of the segment

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

condition

string

CEL expression to evaluate segment membership

Create segment › Responses

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

condition

string

CEL expression to evaluate segment membership

calculation_duration

string | null

How long the last calculation took

error_message

string

Error details if calculation failed

POST/v1/segments

curl --request POST \
  --url https://api.preo.dev/v1/segments \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_id": "organization_id",
  "edition_id": "edition_id",
  "consent_id": "consent_id",
  "name": "name",
  "description": "description",
  "communication_type": "transactional",
  "communication_channel": "any",
  "condition": "condition"
}
'

shell

Example Request Body

{
  "organization_id": "organization_id",
  "edition_id": "edition_id",
  "consent_id": "consent_id",
  "name": "name",
  "description": "description",
  "communication_type": "transactional",
  "communication_channel": "any",
  "condition": "condition"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "edition_id": "edition_id",
  "consent_id": "consent_id",
  "name": "name",
  "description": "description",
  "status": "draft",
  "communication_type": "transactional",
  "communication_channel": "any",
  "user_count": 0,
  "last_calculated": "2024-08-25T15:00:00Z",
  "created": "2024-08-25T15:00:00Z",
  "modified": "2024-08-25T15:00:00Z",
  "condition": "condition",
  "calculation_duration": "calculation_duration",
  "error_message": "error_message"
}

json

application/json

Retrieve segment

GET

https://api.preo.dev

/v1/segments/{id}

Manage customer segments with CEL-based conditions.

Retrieve segment › path Parameters

id

string · required

A unique value identifying this Customer Segment.

Retrieve segment › Responses

200

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

condition

string

CEL expression to evaluate segment membership

calculation_duration

string | null

How long the last calculation took

error_message

string

Error details if calculation failed

Delete segment

DELETE

https://api.preo.dev

/v1/segments/{id}

Manage customer segments with CEL-based conditions.

Delete segment › path Parameters

id

string · required

A unique value identifying this Customer Segment.

Delete segment › Responses

No response body

No data returned

Update segment

PATCH

https://api.preo.dev

/v1/segments/{id}

Manage customer segments with CEL-based conditions.

Update segment › path Parameters

id

string · required

A unique value identifying this Customer Segment.

Update segment › Request Body

name

string · maxLength: 255

Human-readable segment name

description

string

Optional description of the segment

edition_id

string | null

consent_id

string | null

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

condition

string

CEL expression to evaluate segment membership

Update segment › Responses

200

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

condition

string

CEL expression to evaluate segment membership

calculation_duration

string | null

How long the last calculation took

error_message

string

Error details if calculation failed

PATCH/v1/segments/{id}

curl --request PATCH \
  --url https://api.preo.dev/v1/segments/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description",
  "edition_id": "edition_id",
  "consent_id": "consent_id",
  "communication_type": "transactional",
  "communication_channel": "any",
  "condition": "condition"
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "description",
  "edition_id": "edition_id",
  "consent_id": "consent_id",
  "communication_type": "transactional",
  "communication_channel": "any",
  "condition": "condition"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "edition_id": "edition_id",
  "consent_id": "consent_id",
  "name": "name",
  "description": "description",
  "status": "draft",
  "communication_type": "transactional",
  "communication_channel": "any",
  "user_count": 0,
  "last_calculated": "2024-08-25T15:00:00Z",
  "created": "2024-08-25T15:00:00Z",
  "modified": "2024-08-25T15:00:00Z",
  "condition": "condition",
  "calculation_duration": "calculation_duration",
  "error_message": "error_message"
}

json

application/json

Export segment users as CSV

GET

https://api.preo.dev

/v1/segments/{id}/export

Manage customer segments with CEL-based conditions.

Export segment users as CSV › path Parameters

id

string · required

A unique value identifying this Customer Segment.

Export segment users as CSV › Responses

200

string · binary

Recalculate segment

POST

https://api.preo.dev

/v1/segments/{id}/recalculate

Manage customer segments with CEL-based conditions.

Recalculate segment › path Parameters

id

string · required

A unique value identifying this Customer Segment.

Recalculate segment › Responses

200

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

condition

string

CEL expression to evaluate segment membership

calculation_duration

string | null

How long the last calculation took

error_message

string

Error details if calculation failed

Reset stuck segment to draft

POST

https://api.preo.dev

/v1/segments/{id}/reset

Manage customer segments with CEL-based conditions.

Reset stuck segment to draft › path Parameters

id

string · required

A unique value identifying this Customer Segment.

Reset stuck segment to draft › Responses

200

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

condition

string

CEL expression to evaluate segment membership

calculation_duration

string | null

How long the last calculation took

error_message

string

Error details if calculation failed

Get CEL context schema and dynamic values

GET

https://api.preo.dev

/v1/segments/cel-context

Manage customer segments with CEL-based conditions.

Get CEL context schema and dynamic values › query Parameters

organization_id

string · required

Organization ID

edition_id

string

Edition ID (optional)

Get CEL context schema and dynamic values › Responses

200

object · required

object[] · required

object · required

GET/v1/segments/cel-context

curl --request GET \
  --url 'https://api.preo.dev/v1/segments/cel-context?organization_id=%3Cstring%3E'

shell

Example Responses

{
  "schema": {
    "key": {
      "type": "type",
      "description": "description",
      "fields": {
        "key": {}
      }
    }
  },
  "functions": [
    {
      "name": "name",
      "syntax": "syntax",
      "description": "description",
      "example": "example"
    }
  ],
  "examples": [
    {
      "description": "description",
      "expression": "expression"
    }
  ],
  "dynamic_values": {
    "editions": [
      {
        "slug": "slug",
        "full_name": "full_name"
      }
    ],
    "categories": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "products": [
      {
        "id": "id",
        "name": "name",
        "variants": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "category_ids": [
          "string"
        ]
      }
    ],
    "vendors": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "locations": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "product_types": [
      "string"
    ],
    "purchase_statuses": [
      "string"
    ],
    "marketing_consents": [
      {
        "id": "id",
        "title": "title"
      }
    ]
  }
}

json

application/json

Validate CEL expression

POST

https://api.preo.dev

/v1/segments/validate-cel

Manage customer segments with CEL-based conditions.

Validate CEL expression › Request Body

condition

string · required

Validate CEL expression › Responses

200

valid

boolean · required

error

string | null · required

Email Messages Webhooks