Create a segment

POST

segments

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.segments.create({ definition: { conditions: [{ field: "status", op: "in", value: ["active", "replied"] }, { activity: { action: "clicked", campaignIds: ["prg_tz4a98xat96iws9zmbrgj3a"], withinDays: 30 }, did: true }], match: "all" }, name: "Engaged US leads" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "definition": {
    "conditions": [
      {
        "field": "status",
        "op": "in",
        "value": [
          "active",
          "replied"
        ]
      },
      {
        "activity": {
          "action": "clicked",
          "campaignIds": [
            "prg_tz4a98xat96iws9zmbrgj3a"
          ],
          "withinDays": 30
        },
        "did": true
      }
    ],
    "match": "all"
  },
  "description": "US leads who opened or replied in the last 30 days.",
  "id": "seg_tz4a98xat96iws9zmbrgj3a",
  "name": "Engaged US leads",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "segment",
  "updatedAt": "<unknown>"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Headers

Idempotency-Key

string

Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Maximum string length: 255

Body

application/json

definition

AudienceFilterInput · object

required

The audience filter that defines membership; its conditions are evaluated live against your people.

Show child attributes

Example:

{
  "conditions": [
    {
      "field": "status",
      "op": "in",
      "value": ["active"]
    }
  ],
  "match": "all"
}

name

string

required

The segment's display name.

Required string length: 1 - 120

Example:

"Engaged US leads"

description

string

Optional notes on the segment's intent.

Maximum string length: 500

Example:

"US leads who opened or replied in the last 30 days."

Response

definition

AudienceFilter · object

required

The saved audience filter that defines membership, evaluated live against people on every read.

Show child attributes

description

string | null

required

Optional notes on the segment's intent.

Example:

"US leads who opened or replied in the last 30 days."

string

required

The segment id.

Example:

"seg_tz4a98xat96iws9zmbrgj3a"

name

string

required

The segment's display name.

Example:

"Engaged US leads"

archivedAt

any

Timestamp (RFC 3339) when this was archived, or null if active.

createdAt

any

Creation timestamp (RFC 3339).

object

any

default:segment

Always "segment".

updatedAt

any

Last-update timestamp (RFC 3339).

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.segments.create({ definition: { conditions: [{ field: "status", op: "in", value: ["active", "replied"] }, { activity: { action: "clicked", campaignIds: ["prg_tz4a98xat96iws9zmbrgj3a"], withinDays: 30 }, did: true }], match: "all" }, name: "Engaged US leads" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "definition": {
    "conditions": [
      {
        "field": "status",
        "op": "in",
        "value": [
          "active",
          "replied"
        ]
      },
      {
        "activity": {
          "action": "clicked",
          "campaignIds": [
            "prg_tz4a98xat96iws9zmbrgj3a"
          ],
          "withinDays": 30
        },
        "did": true
      }
    ],
    "match": "all"
  },
  "description": "US leads who opened or replied in the last 30 days.",
  "id": "seg_tz4a98xat96iws9zmbrgj3a",
  "name": "Engaged US leads",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "segment",
  "updatedAt": "<unknown>"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Authorizations

Headers

Body

Response