Récupérer et mettre à jour les informations client

  • Customers
  • Compte client
  • 2 routes
Comment récupérer le profil d'un client puis mettre à jour ses informations ?

Ce scénario explique comment lire un profil client puis soumettre une mise à jour sur ce même profil dans un contexte client authentifié.

Vue d'ensemble

Ce scénario aide une application authentifiée à lire le profil client courant puis à soumettre des mises à jour ciblées sur ce même compte.

Prérequis

  • Un customer_id valide.
  • Des headers authorization, accept-language et x-api-key valides.
  • Un payload contenant uniquement les champs de profil à modifier.

Résultat attendu

L'application peut précharger le profil existant, envoyer les changements demandés puis maintenir la fiche client à jour.

Process workflow

Legend:
Obligatoire
Optionnel
1

Récupérer le profil client

Obligatoire

Utilisez GET/v2/customers/{customer_id}/profile pour lire le profil client courant avant d'afficher ou de modifier les informations de compte dans un parcours authentifié.

Prerequis

  • Le customer_id doit correspondre à un compte client existant.
  • Envoyez accept-language, authorization et x-api-key.
  • Exécutez cette étape avant de construire le payload de mise à jour de l'étape suivante.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v2/customers/123456789/profile' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "email": "tom@example.com",
  "gm_number": "123456789",
  "first_name": "Tom",
  "second_name": "James",
  "third_name": "Edward",
  "last_name": "Smith",
  "birth_city": "Paris",
  "phones": [
    {
      "number": "0623456789",
      "type": "MOBILE"
    }
  ],
  "loyalty_program": {
    "status": "GOLD",
    "previous_status": "SILVER",
    "is_platinum_for_life": false,
    "points": 1200
  },
  "address": {
    "city": "Aix-en-Provence",
    "zip_code": "75000",
    "country_code": "FR"
  },
  "locale": "fr-FR"
}

info: v2 est la meilleure source pour préremplir un formulaire d'édition sans perdre les noms secondaires, la ville de naissance ou les champs de fidélité enrichis.

Codes de reponse

  • OK Response (200): retourne le profil détaillé du client avec les informations d'identité, de contact, de fidélité et de locale.
  • Error (400): la validation de la requête a échoué ou une valeur d'entrée est mal formée.
  • Error (401): l'authentification est absente, invalide ou expirée.
  • Error (403): l'accès à ce profil client est interdit dans le contexte courant.
  • Error (404): le profil client est introuvable.
GET/v2/customers/{customer_id}/profile
Voir plus
2

Mettre à jour le profil client

Obligatoire

Cette route met à jour les informations détaillées d'un compte client. Le Swagger précise que tous les champs sont optionnels : envoyez uniquement ceux que vous souhaitez modifier. Les clés absentes ou undefined sont ignorées, tandis que null et les chaînes vides sont enregistrés comme null.

Prérequis

  • Réutiliser le customer_id retourné par l'étape de lecture du profil.
  • Envoyer accept-language, authorization et x-api-key.
  • Utiliser le paramètre de query optionnel force_address si vous devez forcer une adresse inconnue de la base courante.

Calling CURL

curl -X 'PATCH' \
  'https://api.clubmed.com/v1/customers/123456789/profile?force_address=false' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data-raw @profile-update.json

Example answer

HTTP/1.1 204 No Content

info: Toute autre valeur non vide est appliquée telle qu'elle est envoyée dans le payload.

Codes de réponse

  • OK Response (200): non documenté dans le Swagger. Le contrat de succès est 204 No Content, donc aucun body n'est retourné.
  • Error (400): le payload est invalide, incomplet ou n'est pas un JSON valide.
  • Error (401): l'authentification est absente, invalide ou expirée.
  • Error (403): l'appelant n'est pas autorisé à mettre à jour ce profil client.
  • Error (404): le profil client est introuvable.
PATCH/v1/customers/{customer_id}/profile
Voir plus