Segments

Update a segment

patch/api/segments/{id}

Request

Base URL
https://docs.navistone.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/navistone/apis/zazmic-platform-api/docs/api/segments/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Example:123e4567-e89b-12d3-a456-426614174000

Segment ID

Request body

namestring

Segment name

descriptionstring

Segment description

domainIdstring

Domain ID this segment belongs to

Example request

{
  "name": "High Value Customers",
  "description": "Customers with lifetime value over $1000",
  "domainId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Segment updated successfully

Changes

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