Segments

Save a reusable dynamic audience definition. Exact previews are timestamped background snapshots, while an outbound campaign resolves its own guarded audience from the then-current definition. Saving sends nothing and does not copy contacts.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "rules": [
      {
        "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
        "field": "example",
        "operator": "equals"
      }
    ]
  }'

Over MCP the same operation is the tool segments_create at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a saved Smart Segment. Contacts are never deleted. The database refuses deletion while any campaign still includes or excludes the segment so a draft audience cannot silently expand.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool segments_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

List every Smart Segment scalar field and correlated relationship, its supported operators and filters, the account's custom contact fields, and current tenant-scoped choices such as tags, lists, pipelines, team members, forms, Stripe accounts, and Stripe products. Read-only and performs no provider calls.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.fields \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool segments_fields at https://app.chirply.io/api/mcp, same bearer token, same input.

Get one saved Smart Segment and its complete rule definition. This reads the saved configuration and does not evaluate contacts.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool segments_get at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the durable progress or exact final result of a Smart Segment evaluation started by segments.preview or segments.refresh. Preparing results never expose a partial count as final; ready results return the exact count and at most five deterministic sample contact ids. Reads only and sends nothing.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.get_evaluation \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "evaluation_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool segments_get_evaluation at https://app.chirply.io/api/mcp, same bearer token, same input.

List the organization's saved Smart Segments, including their complete validated rule definitions and last successful display-only count metadata. This does not evaluate membership.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool segments_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Validate unsaved Smart Segment conditions and start a tenant-scoped, exact background evaluation. Large accounts return a preparing status and durable evaluation id for segments.get_evaluation; a final count and up to five sample contact ids appear only after concurrent CRM changes are reconciled. Reads only and sends nothing.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.preview \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "rules": [
      {
        "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
        "field": "example",
        "operator": "equals"
      }
    ]
  }'

Over MCP the same operation is the tool segments_preview at https://app.chirply.io/api/mcp, same bearer token, same input.

Start or deduplicate an exact background evaluation of one saved Smart Segment's current definition. The saved display count is published only if the definition and tenant configuration remain unchanged through final reconciliation. Sends nothing and does not alter contacts.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.refresh \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool segments_refresh at https://app.chirply.io/api/mcp, same bearer token, same input.

Replace a Smart Segment's name, description, matching mode, and complete validated rule set. Prior preview counts become historical, future evaluations use the new definition, and already-enrolled campaign recipients do not change.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/segments.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "name": "Example",
    "match_type": "all",
    "rules": [
      {
        "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
        "field": "example",
        "operator": "equals"
      }
    ]
  }'

Over MCP the same operation is the tool segments_update at https://app.chirply.io/api/mcp, same bearer token, same input.