Pular para o conteúdo
DELETE/contatos/{id}

Apagar contato

contatos:escrever

Apaga o contato e as conversas dele. Não tem volta.

DELETE /contatos/{id}

curl -X DELETE "https://chat.forsi.com.br/api/v1/contatos/08054a7f-a752-481e-9915-cf4cf944df39" \
  -H "Authorization: Bearer $FORSI_CHAVE"
Resposta 200
{"dados":{"apagado":false,"conversas_apagadas":1}}

Parâmetros no caminho#

  • iduuidobrigatório

    No caminho da URL.

Resposta#

200 com {"dados": ...}: Apagado.

  • apagadobooleanopcional
    —
  • conversas_apagadasintegeropcional
    —

Erros#

Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.

Status de erro desta operação
StatusQuando
401Chave ausente ou inválida (resposta igual para qualquer motivo).
403Plano sem API, escopo insuficiente ou https/origem recusados.
404Não existe nesta organização.
409Conflito (repetido, Idempotency-Key com outro corpo).
422Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s).
429Limite de requisições. Veja Retry-After.
Códigos de erro que esta área pode devolver4
  • contato_inexistenteContato não encontrado.
  • telefone_invalidoTelefone inválido. Mande com DDI e DDD.
  • telefone_repetidoJá existe um contato com esse telefone (com ou sem o 9).
  • cursor_invalidoCursor inválido. Use o valor de "proximo" da página anterior.

Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.