Synupv1
Crear clave
v1Recursos/Clients/deleteArchivar un cliente

Archivar un cliente

Solicita el archivado de un cliente — esta API nunca lo elimina de forma permanente. Si el cliente tiene alguna ubicación, esto lo PROGRAMA: el cliente y todas sus ubicaciones se archivan al final del periodo de facturación actual, y hasta entonces todo permanece totalmente activo y facturado — el archivado puede cancelarse con el endpoint cancel-archive. Un cliente sin ninguna ubicación se archiva de inmediato en su lugar (no hay nada que diferir). El campo outcome de la respuesta indica cuál de los dos ocurrió realmente.

delete/api/v1/clients/{id}
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a archivar.
Respuesta
dataobjectopcional
Los campos presentes dependen de outcome: scheduled incluye scheduledArchiveAt/archiveAt/locationCount; archived incluye locationsArchived/locationsFailed/cancelledScheduledPosts.
outcomestring (scheduled | archived)obligatorio
Lo que realmente ocurrió: archived (inmediato — no existían ubicaciones, o ninguna estaba activa) o scheduled (se archiva al final del periodo de facturación).
clientIdstringobligatorio
Identificador único del cliente.
businessNamestringobligatorio
El nombre comercial del cliente.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
archiveAtstringopcional
Cuándo se producirá realmente el archivado programado — el límite de facturación de la agencia. Null si la agencia no tiene ninguno. Presente solo cuando outcome es scheduled.
locationCountnumberopcional
Número de ubicaciones que tiene este cliente, o null si se desconoce.
locationsArchivednumberopcional
Número de ubicaciones archivadas junto con el cliente. Presente solo cuando outcome es archived.
locationsFailednumberopcional
Número de ubicaciones cuyo archivado falló. Presente solo cuando outcome es archived.
cancelledScheduledPostsnumberopcional
Número de publicaciones programadas canceladas como parte del archivado. Presente solo cuando outcome es archived.
Errores
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.
delete/api/v1/clients/{id}
Su clave de API
id *
{
  "data": {
    "outcome": "scheduled",
    "clientId": "cli_123",
    "businessName": "Acme Dental",
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z",
    "locationCount": 1
  }
}