v1Recursos/Clients/postCancelar um arquivamento agendado

Cancelar um arquivamento agendado

Cancela um arquivamento de cliente pendente, de modo que um cliente agendado para arquivar no final do período de faturamento continue normalmente. Também libera os locais que estavam agendados junto com ele. Só funciona enquanto o arquivamento ainda estiver pendente — um cliente já totalmente arquivado precisa ser reativado, através do endpoint reactivate.

post/api/v1/clients/{id}/cancel-archive

clients:write

Parâmetros de consulta

idstringobrigatório

O cliente cujo arquivamento pendente deve ser cancelado.

Resposta

dataobjectopcional

cancelledbooleanopcional

Sempre true em caso de sucesso.

locationsReleasednumberopcional

Número de locais liberados do agendamento de arquivamento cancelado.

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.

post/api/v1/clients/{id}/cancel-archive

Sua chave de API

id *

{
  "data": {
    "cancelled": true,
    "locationsReleased": 1
  }
}