Créer une clé de préférence tenant

POST

/v1/preference-keys

curl --request POST \
  --url https://example.com/v1/preference-keys \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "code": "PILLOW_TYPE", "label": "Type d'\''oreiller", "valueType": "text", "category": "stay", "options": [ { "value": "example", "sortOrder": 0 } ] }'

Crée une nouvelle clé de préférence (is_system=false) pour le tenant courant. Le code doit être unique au sein du tenant. Pour valueType=enum, au moins une option initiale est requise.

Authorizations

• ApiKeyAuth
• BearerAuth

Request Body ^required

Media type application/json

object

code

required

Code unique tenant, majuscules conseillées

string

Example

PILLOW_TYPE

label

required

string

Example

Type d'oreiller

valueType

required

string

Allowed values: text integer boolean enum

category

required

string

Allowed values: stay accessibility arrival camping

options

Options initiales — obligatoires ssi valueType=enum

Array<object>

object

value

required

string

sortOrder

integer

0

Responses

201

Clé créée

Media type application/json

object

data

required

object

id

required

string format: uuid

code

required

string

label

required

string

valueType

required

string

Allowed values: text integer boolean enum

category

required

string

Allowed values: stay accessibility arrival camping

isSystem

required

boolean

active

required

boolean

options

required

Valeurs enum valides (vide si valueType != enum)

Array<string>

Example

{
  "data": {
    "valueType": "text",
    "category": "stay"
  }
}

400

Corps invalide ou contrainte métier

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée (guest.create)

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

409

Code déjà pris pour ce tenant

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}