Segments

Update segment

Changed on

Updates a saved segment's name or filter definition.

patch/segments/{segmentId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/segments/{segmentId}
  • Auth
    HTTP bearer

Path parameters

segmentIdstring required

Request body

namestring
filterJoinOperator'and' | 'or'

Example request

{
  "filters": [
    {
      "id": "filter-1"
    }
  ],
  "root": {
    "id": "root",
    "children": [
      {
        "id": "filter-1"
      }
    ]
  }
}

Response

Segment updated

successboolean
warningsstring[]

Non-fatal cautions, such as an attribute filter referencing a custom attribute no subscriber has a synced value for (which would match no subscribers, or every subscriber for exclusion operators like is_empty). Absent when there is nothing to warn about.

Example response

{
  "segment": {
    "id": "seg_active_buyers",
    "name": "Active buyers",
    "filters": [
      {
        "id": "filter-1"
      }
    ],
    "root": {
      "id": "root",
      "children": [
        {
          "id": "filter-1"
        }
      ]
    }
  }
}

Changes

  • db3873ca3d4dRevision changes
    • warning

      added the new pushClicked enum value to the /// response property for the response status

    • warning

      added the new pushClicked enum value to the ///////////// response property for the response status

    • warning

      added the new pushDelivered enum value to the /// response property for the response status

    • warning

      added the new pushDelivered enum value to the ///////////// response property for the response status

    • warning

      added the new pushDevice enum value to the /// response property for the response status

    • warning

      added the new pushDevice enum value to the ///////////// response property for the response status

    • warning

      added the new pushSent enum value to the /// response property for the response status

    • warning

      added the new pushSent enum value to the ///////////// response property for the response status

    • info

      added the new pushClicked enum value to the request property //

    • info

      added the new pushClicked enum value to the request property ///////

    • info

      added the new pushDelivered enum value to the request property //

    • info

      added the new pushDelivered enum value to the request property ///////

    • info

      added the new pushDevice enum value to the request property //

    • info

      added the new pushDevice enum value to the request property ///////

    • info

      added the new pushSent enum value to the request property //

    • info

      added the new pushSent enum value to the request property ///////

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • info

      added filter group discriminator mapping keys to the // request property

    • info

      removed from the / response property allOf list for the response status

    • info

      added subschema #1 subschema #2 to the / response property anyOf list for the response status