lomi.
Clients

Mettre à jour un client

Mettre à jour un client

Aperçu

Mettre à jour un client

Met à jour un client. N'envoyez que les champs à modifier. Réponse 404 si le client n'existe pas ou n'est pas accessible avec cette clé API.

Quand utiliser cet endpoint

Utilisez cet endpoint quand vous devez exécuter PATCH /customers/{id} (Mettre à jour un client).

Authentification

Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Aperçu de l’intégration). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.

Point de terminaison

PATCH /customers/{id}

URLs de base :

  • https://sandbox.api.lomi.africa
  • https://api.lomi.africa

Requête

Paramètres de chemin

NomObligatoireSchémaDescription
idOuiUUID du client

Paramètres de requête

Aucun paramètre de requête.

Corps de la requête

Charge utile JSON.

Schéma: object

ChampObligatoireTypeDescription
nameNonstring
emailNonstring
phone_numberNonstring
whatsapp_numberNonstring
countryNonstring
cityNonstring
addressNonstring
postal_codeNonstring
is_businessNonboolean
metadataNonobject

Exemple de corps :

{
  "name": "string",
  "email": "string",
  "phone_number": "string"
}

Réponses

StatutDescription
200Client mis à jour avec succès
400Données d'entrée invalides
401Clé API invalide ou manquante
404Client introuvable ou accès refusé

Erreurs

Les erreurs suivent le format JSON standard (code de statut et message lisible par machine). Validez les entrées avant appel ; 401 indique une clé manquante/invalide, 404 une ressource introuvable pour cette organisation, 429 une limitation de débit. Pour les retries sûrs sur les créations, envoyez une clé d’idempotence quand votre flux le permet.

Exemple

curl -sS -X PATCH "https://sandbox.api.lomi.africa/customers/value" \
  -H "X-API-KEY: $LOMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","email":"string","phone_number":"string"}'

OpenAPI

  • operationId: CustomersController_update
  • Operation: PATCH /customers/{id}

Schémas complets et Try it : référence API. Contrat machine : openapi.json à la racine des docs.

Sur cette page