PEPINO ZAPdocs
Referência da APIInbox

Muda o status (encerrar/reabrir) da conversa

Ver como Markdown
POST
/v1/inbox/conversations/{id}/status

Define o status da conversa: open, pending ou resolved. Ao RESOLVER (resolved) voce pode anexar a justificativa de encerramento: closeReasonId (um motivo do catalogo do Projeto — veja Justificativas) e/ou closeNotes (observacao livre). Reabrir (open/pending) limpa a justificativa anterior. O closeReasonId precisa existir no Projeto; invalido retorna 400.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador da conversa.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/inbox/conversations/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "resolved",    "closeReasonId": "cr_01HV9Z3K8Q",    "closeNotes": "Cliente resolveu pelo app."  }'
Empty
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}