Synup
Create a key
v1Resources/Clients/postAdd client credits

Add client credits

Add positive whole credits as the API-key creator, with the same Clients and client-access checks as the UI. Requires explicit client-credits:write permission. Supply an idempotency key in the header or body; if both are present they must match. Reuse the same key, amount and note when retrying; a changed payload returns 409. Retries return the current wallet view. The receipt is scoped to the agency, client and user and works across REST and MCP. Subtraction, package changes and hidden allocation settings are not supported.

post/api/v1/clients/{id}/credits
client-credits:write
Query parameters
Idempotency-Keystringoptional
Required in either the Idempotency-Key header or the idempotencyKey body field. Use 8–200 characters. Reuse it for retries of the same grant; use a new key for a new grant.
Request body
creditsintegerrequired
Positive whole credits to add, from 1 to 1,000,000,000.
notestringoptional
Optional note for the customer-visible credit history, up to 200 characters.
idempotencyKeystringoptional
Required in either the Idempotency-Key header or the idempotencyKey body field. Use 8–200 characters. Reuse it for retries of the same grant; use a new key for a new grant.
Response
dataobjectrequired
clientIdstringrequired
givenintegerrequired
usedintegerrequired
remainingintegerrequired
lastAddedobjectrequired
creditsintegerrequired
atstringrequired
usedSinceintegerrequired
bystringrequired
historyarray of objectrequired
creditsintegerrequired
remainingAfterintegerrequired
notestringrequired
atstringrequired
bystringrequired
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
post/api/v1/clients/{id}/credits
Your API key
Idempotency-Key
Request body*
{}

Guides that use this resource