PEPINO ZAPdocs
Referência da APIInbox

Edita o contato da conversa

Ver como Markdown
PATCH
/v1/inbox/conversations/{id}/contact

Atualiza os dados do contato vinculado a conversa — na implementacao atual, renomeia o contato (edicao manual do atendente). name e obrigatorio (trim aplicado; nao pode ficar vazio). A conversa precisa pertencer ao Projeto (senao 404). Como o nome incide sobre o contato (que pode aparecer em mais de uma conversa), a mudanca reflete em todas as conversas daquele contato. Responde 204 sem corpo.

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.

name*string

Novo nome de exibicao do contato. Trim aplicado; nao pode ficar vazio.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/inbox/conversations/string/contact" \  -H "Content-Type: application/json" \  -d '{    "name": "Joao da Silva"  }'
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"
  }
}