Ajouter une note interne sur un client (safety / commercial / operational)

POST

/v1/guests/{id}/notes

curl --request POST \
  --url https://example.com/v1/guests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notes \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "kind": "safety", "text": "example", "restrictedToRoles": [ "example" ] }'

Note CRM front-desk. safety toujours visible au staff ; les autres peuvent être restreintes à des rôles (restrictedToRoles).

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body ^required

Media type application/json

object

kind

required

string

Allowed values: safety commercial operational

text

required

string

<= 2000 characters

restrictedToRoles

Rôles autorisés à lire (vide = tout le staff ; ignoré pour safety)

Array<string>

Responses

201

Note ajoutée

Media type application/json

object

data

required

object

noteId

required

string format: uuid

Example ^generated

{
  "data": {
    "noteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

400

Catégorie ou texte 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
}

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.note)

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
}