Sign in
Market Segmentation

Update a Market Segmentation Segment.

patch/market-segmentation/v1/segments/{id}

Path parameters

idId required— unresolved $ref

Segment ID.

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

idstring required

Segment ID.

groupIdstring required

Group ID.

namestring required

Segment name.

codestring required

Segment code.

descriptionstring required

Segment description.

isEnabledboolean required

Is Segment enabled?.

ratePlanIdsstring[] required

List of Rate Plan IDs.

Example request

{
  "id": "1-b",
  "groupId": "1-b",
  "name": "Abc",
  "code": "1000",
  "description": "This is a Segment",
  "isEnabled": true,
  "ratePlanIds": [
    "1-a",
    "2-b",
    "3-c"
  ]
}

Response

Updated Market Segmentation Segment.

idstring
groupIdstring
namestring
codestring
descriptionstring
isEnabledboolean
isDefaultboolean
ratePlanIdsstring[]
createdAtstring Y-m-d\TH:i:sP
updatedAtstring Y-m-d\TH:i:sP nullable
canEditstring[]
canDeleteboolean
canDisableboolean

Changes