FLfloqer
ackDB

Update a segment

Updates a Segment in place (no version chain). Only the provided fields are changed. Requires edit access - owner, edit-grantee, or a legacy owner-less segment; 403 otherwise (#284).

put/api/v1/ackdb/observe/segments/{id}

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring
descriptionstring

Example request

{
  "filter": {
    "children": [
      {
        "traitKey": "hubspot_lifecycle_stage"
      }
    ]
  },
  "sort": [
    {
      "field": "event_count"
    }
  ],
  "columns": [
    {
      "field": "name",
      "frozen": true,
      "width": 200
    }
  ]
}

Response

The updated segment.

Example response

{
  "data": {
    "id": "01J9Z8Q3K2X7M4N5P6R7S8T9V0",
    "name": "Active paying companies",
    "description": "Companies with a paid Stripe invoice",
    "entityKind": "company",
    "filter": {
      "children": [
        {
          "traitKey": "hubspot_lifecycle_stage"
        }
      ]
    },
    "sort": [
      {
        "field": "event_count"
      }
    ],
    "columns": [
      {
        "field": "name",
        "frozen": true,
        "width": 200
      }
    ],
    "ownerEmail": "rep@acme.com",
    "access": "owner"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.