Segment CREATE

POST 
/v1/segments

Create a new segment. The name must be unique across all segments.

Request

application/json

Body

required

name stringrequired
description stringrequired
value_source_attribute stringrequired

Responses

200

Ok

application/json

Schema

Schema

errors undefined[]required
segment objectrequired
created_by objectrequired
avatar objectrequired
crop_height doublerequired
crop_width doublerequired
crop_top doublerequired
crop_left doublerequired
base_url stringrequired
content_type stringrequired
file_name stringrequired
file_size doublerequired
height doublerequired
width doublerequired
file_usage_id doublerequired
created_by_user_id doublerequired
created_at date-timerequired
id doublerequired
date_format_locale stringrequired
demo_user booleanrequired
last_login_failure_at date-timerequired
last_login_at date-timerequired
consecutive_login_failures doublerequired
archived booleanrequired
avatar_file_upload_id doublerequired
job_title stringrequired
department stringrequired
last_name stringrequired
first_name stringrequired
email stringrequired
external_id doublerequired
updated_by_user_id doublerequired
updated_at date-timerequired
created_by_user_id doublerequired
created_at date-timerequired
id doublerequired
updated_by_user_id doublerequired
updated_at date-timerequired
created_by_user_id doublerequired
created_at date-timerequired
value_source_attribute stringrequired
description stringrequired
name stringrequired
id doublerequired
ok booleanrequired

Example (from schema)

{
  "errors": [
    null
  ],
  "segment": {
    "created_by": {
      "avatar": {
        "crop_height": 0,
        "crop_width": 0,
        "crop_top": 0,
        "crop_left": 0,
        "base_url": "string",
        "content_type": "string",
        "file_name": "string",
        "file_size": 0,
        "height": 0,
        "width": 0,
        "file_usage_id": 0,
        "created_by_user_id": 0,
        "created_at": "2026-05-12T11:17:56.226Z",
        "id": 0
      },
      "date_format_locale": "string",
      "demo_user": true,
      "last_login_failure_at": "2026-05-12T11:17:56.226Z",
      "last_login_at": "2026-05-12T11:17:56.226Z",
      "consecutive_login_failures": 0,
      "archived": true,
      "avatar_file_upload_id": 0,
      "job_title": "string",
      "department": "string",
      "last_name": "string",
      "first_name": "string",
      "email": "string",
      "external_id": 0,
      "updated_by_user_id": 0,
      "updated_at": "2026-05-12T11:17:56.226Z",
      "created_by_user_id": 0,
      "created_at": "2026-05-12T11:17:56.226Z",
      "id": 0
    },
    "updated_by_user_id": 0,
    "updated_at": "2026-05-12T11:17:56.226Z",
    "created_by_user_id": 0,
    "created_at": "2026-05-12T11:17:56.226Z",
    "value_source_attribute": "string",
    "description": "string",
    "name": "string",
    "id": 0
  },
  "ok": true
}

400

Unique constraint violation

application/json

Schema

Schema

ok booleanrequired

Possible values: [false]

errors string[]required

Example (from schema)

{
  "ok": false,
  "errors": [
    "string"
  ]
}

422

Validation failed

application/json

Schema

Schema

ok booleanrequired

Possible values: [false]

errors string[]required

Example (from schema)

{
  "ok": false,
  "errors": [
    "string"
  ]
}

Loading...