MarketSegment

Create a market segment

<br>You must have at least one of these scopes: 'settings.manage, setup.manage'.

post/settings/v1/market-segments

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring required

The code of the market segment

namestring required

The name of the market segment

descriptionstring nullable

The description of the market segment

propertyIdsstring[] nullable

The list of property ids this market segment belongs to

Example request

{
  "code": "BUSR",
  "name": "Business Groups",
  "description": "Social groups (Weddings etc.)",
  "propertyIds": [
    "MUC",
    "BER"
  ]
}

Response

Market segment successfully created.

idstring required

The market segment ID

Example response

{
  "id": "BGTF"
}

Changes

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