Modifier une clé de préférence

PATCH

/v1/preference-keys/{id}

curl --request PATCH \
  --url https://example.com/v1/preference-keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "label": "example", "active": true }'

Modifie le label et/ou l’état actif d’une clé. Clés système (is_system=true) : seul active peut être modifié (label immuable). active=false = soft-désactivation (la clé disparaît du référentiel actif).

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

UUID de la clé de préférence

Request Body ^required

Media type application/json

object

label

Nouveau label (interdit sur clés système)

string

active

False = désactivation soft

boolean

Example ^generated

{
  "label": "example",
  "active": true
}

Responses

200

Clé mise à jour

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 tentative de modifier le label d’une clé système

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
}

404

Clé introuvable

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

Transition d’état invalide

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
}