Update a segment

​

Path Parameters

  • segmentId
    Type: integer
    required

    ID of segment

Body·

required
application/json

Segment - array of values to be updated. Requires belonging to the segment audience, or administrator when the segment has none.

  • categories
    Type: array of integer

    Category IDs the segment is assigned to. Part of the segment's audience - see users.

  • customModuleId
    Type: integer

    ID of the custom module when the segment targets a custom module instead of a built-in one

  • description
    Type: string

    More detailed description of segment

  • filter
    Type: string

    Filter expression selecting the records that belong to this segment. Not JSON - it is the same string grammar as the filter query parameter of the record list endpoints, documented there in full: field operator value terms joined with &/; (AND) or | (OR), groups in parentheses, and the same operators (=, !=, >, >=, <, <=, ~/!~ LIKE with % wildcards, ... for an IN set). Example: (name~%acme%&statusId...1,2,3)|spaceId=5.

  • module
    Type: string

    Module this segment applies to (e.g. 'contact', 'deal'); must match a value from the modules table

  • name
    Type: string

    Name of the Segment

  • orderIndex
    Type: integer

    Numeric position used to sort segments in the UI

  • teams
    Type: array of integer

    Team IDs the segment is assigned to. Part of the segment's audience - see users.

  • users
    Type: array of integer

    User IDs the segment is assigned to. Part of the segment's audience together with teams and categories: leaving all three empty makes the segment readable by everyone and editable or deletable only by an administrator, while any non-empty audience restricts it to its members.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/segment/{segmentId}
curl https://test.boost.space/api/segment/1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "name": "Sample name",
  "description": "string",
  "filter": "string",
  "module": "string",
  "orderIndex": 1,
  "customModuleId": 42,
  "users": [
    1
  ],
  "teams": [
    1
  ],
  "categories": [
    1
  ]
}'

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "name": "Sample name",
  "description": "string",
  "filter": "string",
  "module": "string",
  "orderIndex": 1,
  "customModuleId": 42,
  "users": [
    1
  ],
  "teams": [
    1
  ],
  "categories": [
    1
  ]
}

Segment updated record