BeeMessage API
ApiContatos

Atualizar

Atualiza os dados de um contato na plataforma.

Validação de Documento

Ao atualizar os dados de documento do contato, a regra de envio combinado se aplica: Se você enviar um novo idNumber (CPF ou CNPJ), é obrigatório enviar também o seu respectivo idType (CPF ou CNPJ). Da mesma forma, se você quiser alterar o idType, o idNumber também deve vir na requisição.

Os dois campos estão associados e devem ser enviados juntos na carga de atualização, se desejar mexer neles.

PATCH
/v1/contacts/{contactId}
AuthorizationBearer <token>

Insira seu token de acesso abaixo. No Swagger: Não é necessário digitar "Bearer " antes do token, o sistema adiciona automaticamente.

Na API: As requisições devem incluir o header.

Exemplo: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

In: header

Path Parameters

contactId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://core.beemessage.app/v1/contacts/cont_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "data": {
    "id": "cont_abc123"
  }
}
Empty
Empty