Update Segment

PATCHhttps://api.inboxjot.com/v1/segments/{segment_id}

Updates the fields you send and keeps the others. The type cannot change. Needs a Full key. A key limited to one domain answers 403. Send an optional Idempotency-Key header to retry safely. See Idempotency.

PATCH/v1/segments/{segment_id}

curl -X PATCH https://api.inboxjot.com/v1/segments/seg_06d2mfk8r2kd7fq4mx9ab \
  -H "Authorization: Bearer $INBOXJOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Engaged Pro customers"
  }'

{
  "id": "seg_06d2mfk8r2kd7fq4mx9ab",
  "name": "Engaged Pro customers",
  "description": null,
  "type": "dynamic",
  "conditions": {
    "match": "all",
    "rules": [
      {
        "field": "property.plan",
        "operator": "is",
        "value": "pro"
      },
      {
        "field": "email.opened",
        "operator": "within",
        "value": "30d"
      }
    ]
  },
  "contact_count": 1204,
  "counted_at": "2026-10-21T09:00:00.000Z",
  "created_at": "2026-10-01T12:00:00.000Z",
  "updated_at": "2026-10-01T12:00:00.000Z"
}

Returns the updated segment.

Path Parameters

segment_idstringrequired

The segment id.

Body Parameters

namestring | null

The segment name, 1 to 100 characters.

descriptionstring | null

A description. Send null to clear it.

conditionsobject | null

New rules for a dynamic segment. They replace the old ones.

Response

idstring

The segment id.

namestring

The segment name.

descriptionstring | null

The description.

typestring

static or dynamic.

conditionsobject | null

The rules of a dynamic segment. null for a static one.

contact_countinteger | null

How many contacts are in it. null until a dynamic segment is first counted.

counted_atstring | null

When a dynamic segment was last counted.

created_atstring

When it was created.

updated_atstring

When it last changed.

Responses

curl -X PATCH https://api.inboxjot.com/v1/segments/seg_06d2mfk8r2kd7fq4mx9ab \ -H "Authorization: Bearer $INBOXJOT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Engaged Pro customers" }'

{ "id": "seg_06d2mfk8r2kd7fq4mx9ab", "name": "Engaged Pro customers", "description": null, "type": "dynamic", "conditions": { "match": "all", "rules": [ { "field": "property.plan", "operator": "is", "value": "pro" }, { "field": "email.opened", "operator": "within", "value": "30d" } ] }, "contact_count": 1204, "counted_at": "2026-10-21T09:00:00.000Z", "created_at": "2026-10-01T12:00:00.000Z", "updated_at": "2026-10-01T12:00:00.000Z" }