Synup
Crear clave
v1Recursos/Clients/postAñadir créditos al cliente

Añadir créditos al cliente

Añade créditos enteros positivos como el creador de la clave API, con las mismas comprobaciones de acceso a Clientes y al cliente que la interfaz. Requiere permiso explícito client-credits:write. Incluya una clave de idempotencia en la cabecera o en el cuerpo; si aparece en ambos, debe coincidir. Reutilice la misma clave, cantidad y nota al reintentar; cambiar los datos devuelve 409. Los reintentos devuelven el saldo actual. El comprobante se limita a la agencia, el cliente y el usuario, y funciona entre REST y MCP. No se admiten restas, cambios de paquetes ni ajustes ocultos de asignación.

post/api/v1/clients/{id}/credits
client-credits:write
Parámetros de consulta
Idempotency-Keystringopcional
Obligatoria en la cabecera Idempotency-Key o en el campo idempotencyKey del cuerpo. Use entre 8 y 200 caracteres. Reutilícela al reintentar la misma asignación; use una clave nueva para una asignación nueva.
Cuerpo de la solicitud
creditsintegerobligatorio
Créditos enteros positivos que se añadirán, entre 1 y 1.000.000.000.
notestringopcional
Nota opcional para el historial de créditos visible para el cliente, de hasta 200 caracteres.
idempotencyKeystringopcional
Obligatoria en la cabecera Idempotency-Key o en el campo idempotencyKey del cuerpo. Use entre 8 y 200 caracteres. Reutilícela al reintentar la misma asignación; use una clave nueva para una asignación nueva.
Respuesta
dataobjectobligatorio
clientIdstringobligatorio
givenintegerobligatorio
usedintegerobligatorio
remainingintegerobligatorio
lastAddedobjectobligatorio
creditsintegerobligatorio
atstringobligatorio
usedSinceintegerobligatorio
bystringobligatorio
historyarray of objectobligatorio
creditsintegerobligatorio
remainingAfterintegerobligatorio
notestringobligatorio
atstringobligatorio
bystringobligatorio
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
503El servicio no está disponible temporalmente. Reintente la asignación de créditos con la misma clave de idempotencia.
post/api/v1/clients/{id}/credits
Su clave de API
Idempotency-Key
Cuerpo de la solicitud*
{}

Guías que usan este recurso