v1Recursos/Locations/postAgendar o arquivamento de um local

Agendar o arquivamento de um local

AGENDA um local para arquivar no final do período de faturamento atual. Até então, o local permanece totalmente ativo, faturável e continua contando para o limite de locais do plano — nada é excluído, e o agendamento não libera espaço para adicionar outro local até que o arquivamento realmente ocorra. Chame cancel-archive para cancelar isso antes que aconteça, ou reactivate depois para trazer o local de volta.

post/api/v1/locations/{id}/archive

locations:write

Parâmetros de consulta

idstringobrigatório

O local a agendar para arquivamento.

Resposta

dataobjectopcional

scheduledbooleanopcional

Sempre true em caso de sucesso.

scheduledArchiveAtstringopcional

Quando o arquivamento foi solicitado (também o token usado por cancel-archive para correspondência), 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.

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/locations/{id}/archive

Sua chave de API

id *

{
  "data": {
    "scheduled": true,
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z"
  }
}