Synup
Schlüssel erstellen
v1Ressourcen/Clients/postKundenguthaben hinzufügen

Kundenguthaben hinzufügen

Fügt als Ersteller des API-Schlüssels positive, ganze Guthabeneinheiten hinzu. Es gelten dieselben Zugriffsprüfungen für Kunden wie in der Benutzeroberfläche. Erfordert die ausdrückliche Berechtigung client-credits:write. Geben Sie einen Idempotenzschlüssel im Header oder im Anforderungstext an; bei beiden Angaben müssen die Werte übereinstimmen. Verwenden Sie bei Wiederholungen denselben Schlüssel, Betrag und Hinweis; geänderte Angaben führen zu 409. Wiederholungen liefern den aktuellen Guthabenstand. Der Beleg gilt für Agentur, Kunde und Benutzer und funktioniert transportübergreifend für REST und MCP. Abzüge, Paketänderungen und verborgene Zuweisungseinstellungen werden nicht unterstützt.

post/api/v1/clients/{id}/credits
client-credits:write
Query-Parameter
Idempotency-Keystringoptional
Erforderlich entweder im Header Idempotency-Key oder im Feld idempotencyKey des Anforderungstexts. Verwenden Sie 8–200 Zeichen. Wiederholen Sie dieselbe Gutschrift mit demselben Schlüssel; verwenden Sie für eine neue Gutschrift einen neuen Schlüssel.
Anfragetext
creditsintegererforderlich
Positive, ganze Guthabeneinheiten zum Hinzufügen, von 1 bis 1.000.000.000.
notestringoptional
Optionaler Hinweis für den für Kunden sichtbaren Guthabenverlauf, maximal 200 Zeichen.
idempotencyKeystringoptional
Erforderlich entweder im Header Idempotency-Key oder im Feld idempotencyKey des Anforderungstexts. Verwenden Sie 8–200 Zeichen. Wiederholen Sie dieselbe Gutschrift mit demselben Schlüssel; verwenden Sie für eine neue Gutschrift einen neuen Schlüssel.
Antwort
dataobjecterforderlich
clientIdstringerforderlich
givenintegererforderlich
usedintegererforderlich
remainingintegererforderlich
lastAddedobjecterforderlich
creditsintegererforderlich
atstringerforderlich
usedSinceintegererforderlich
bystringerforderlich
historyarray of objecterforderlich
creditsintegererforderlich
remainingAfterintegererforderlich
notestringerforderlich
atstringerforderlich
bystringerforderlich
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie eine Gutschrift mit demselben Idempotenzschlüssel.
post/api/v1/clients/{id}/credits
Ihr API-Schlüssel
Idempotency-Key
Anfragetext*
{}

Anleitungen, die diese Ressource verwenden