v1Recursos/Clients/deleteArquivar um cliente

Arquivar um cliente

Solicita o arquivamento de um cliente — esta API nunca exclui um cliente permanentemente. Se o cliente tiver algum local, isso é AGENDADO: o cliente e todos os seus locais são arquivados no final do período de faturamento atual, e até então tudo permanece totalmente ativo e faturado — o arquivamento pode ser cancelado com o endpoint cancel-archive. Já um cliente sem nenhum local é arquivado imediatamente (não há nada a postergar). O campo outcome da resposta informa qual dos dois realmente aconteceu.

delete/api/v1/clients/{id}

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente a arquivar.

Resposta

dataobjectopcional

Quais campos estão presentes depende de outcome: scheduled traz scheduledArchiveAt/archiveAt/locationCount; archived traz locationsArchived/locationsFailed/cancelledScheduledPosts.

outcomestring (scheduled | archived)obrigatório

O que realmente aconteceu: archived (imediato — não existiam locais, ou nenhum estava ativo) ou scheduled (arquiva no final do período de faturamento).

clientIdstringobrigatório

Identificador único do cliente.

businessNamestringobrigatório

O nome comercial do cliente.

scheduledArchiveAtstringopcional

Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.

archiveAtstringopcional

Quando o arquivamento agendado realmente ocorrerá — o limite de faturamento da agência. Null se a agência não tiver nenhum. Presente apenas quando outcome é scheduled.

locationCountnumberopcional

Número de locais deste cliente, ou null se desconhecido.

locationsArchivednumberopcional

Número de locais arquivados junto com o cliente. Presente apenas quando outcome é archived.

locationsFailednumberopcional

Número de locais cujo arquivamento falhou. Presente apenas quando outcome é archived.

cancelledScheduledPostsnumberopcional

Número de publicações agendadas canceladas como parte do arquivamento. Presente apenas quando outcome é archived.

Erros

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.

delete/api/v1/clients/{id}

Sua chave 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
  }
}