Synup
Criar chave
v1Recursos/Clients/postAdicionar créditos ao cliente

Adicionar créditos ao cliente

Adiciona créditos inteiros positivos como o criador da chave API, com as mesmas verificações de acesso a Clientes e ao cliente da interface. Exige a permissão explícita client-credits:write. Informe uma chave de idempotência no cabeçalho ou no corpo; se estiver em ambos, os valores devem coincidir. Reutilize a mesma chave, quantidade e nota ao tentar novamente; alterações retornam 409. Novas tentativas retornam o saldo atual. O recibo é limitado à agência, ao cliente e ao usuário e funciona entre REST e MCP. Não há suporte para subtrações, alterações de pacotes ou configurações ocultas de alocação.

post/api/v1/clients/{id}/credits
client-credits:write
Parâmetros de consulta
Idempotency-Keystringopcional
Obrigatória no cabeçalho Idempotency-Key ou no campo idempotencyKey do corpo. Use de 8 a 200 caracteres. Reutilize-a para novas tentativas do mesmo acréscimo; use uma nova chave para um novo acréscimo.
Corpo da solicitação
creditsintegerobrigatório
Créditos inteiros positivos a adicionar, de 1 a 1.000.000.000.
notestringopcional
Nota opcional para o histórico de créditos visível ao cliente, com até 200 caracteres.
idempotencyKeystringopcional
Obrigatória no cabeçalho Idempotency-Key ou no campo idempotencyKey do corpo. Use de 8 a 200 caracteres. Reutilize-a para novas tentativas do mesmo acréscimo; use uma nova chave para um novo acréscimo.
Resposta
dataobjectobrigatório
clientIdstringobrigatório
givenintegerobrigatório
usedintegerobrigatório
remainingintegerobrigatório
lastAddedobjectobrigatório
creditsintegerobrigatório
atstringobrigatório
usedSinceintegerobrigatório
bystringobrigatório
historyarray of objectobrigatório
creditsintegerobrigatório
remainingAfterintegerobrigatório
notestringobrigatório
atstringobrigatório
bystringobrigatório
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Tente adicionar os créditos novamente com a mesma chave de idempotência.
post/api/v1/clients/{id}/credits
Sua chave de API
Idempotency-Key
Corpo da solicitação*
{}

Guias que usam este recurso