Synup
Créer une clé
v1Ressources/Clients/postAjouter des crédits au client

Ajouter des crédits au client

Ajoute des crédits entiers positifs au nom du créateur de la clé API, avec les mêmes contrôles d’accès à Clients et au client que l’interface. Nécessite l’autorisation explicite client-credits:write. Fournissez une clé d’idempotence dans l’en-tête ou le corps ; si elle figure aux deux endroits, les valeurs doivent correspondre. Réutilisez la même clé, le même montant et la même note lors des nouvelles tentatives ; une modification renvoie 409. Les nouvelles tentatives renvoient le solde actuel. Le reçu est limité à l’agence, au client et à l’utilisateur et fonctionne entre REST et MCP. Les retraits, changements de forfaits et paramètres d’allocation masqués ne sont pas pris en charge.

post/api/v1/clients/{id}/credits
client-credits:write
Paramètres de requête
Idempotency-Keystringfacultatif
Obligatoire dans l’en-tête Idempotency-Key ou le champ idempotencyKey du corps. Utilisez de 8 à 200 caractères. Réutilisez-la pour une nouvelle tentative du même ajout ; utilisez une nouvelle clé pour un nouvel ajout.
Corps de la requête
creditsintegerobligatoire
Crédits entiers positifs à ajouter, de 1 à 1 000 000 000.
notestringfacultatif
Note facultative pour l’historique de crédits visible par le client, de 200 caractères maximum.
idempotencyKeystringfacultatif
Obligatoire dans l’en-tête Idempotency-Key ou le champ idempotencyKey du corps. Utilisez de 8 à 200 caractères. Réutilisez-la pour une nouvelle tentative du même ajout ; utilisez une nouvelle clé pour un nouvel ajout.
Réponse
dataobjectobligatoire
clientIdstringobligatoire
givenintegerobligatoire
usedintegerobligatoire
remainingintegerobligatoire
lastAddedobjectobligatoire
creditsintegerobligatoire
atstringobligatoire
usedSinceintegerobligatoire
bystringobligatoire
historyarray of objectobligatoire
creditsintegerobligatoire
remainingAfterintegerobligatoire
notestringobligatoire
atstringobligatoire
bystringobligatoire
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Le service est temporairement indisponible. Réessayez l’ajout de crédits avec la même clé d’idempotence.
post/api/v1/clients/{id}/credits
Votre clé API
Idempotency-Key
Corps de la requête*
{}

Guides qui utilisent cette ressource