Atualizar pessoa

Atualiza dados de uma pessoa existente na inbox indicada. Campos omitidos permanecem inalterados; tags, quando enviado, substitui toda a lista de tags.

PATCH /people/{peopleId}

Atualizar pessoa

cURL

curl --request PATCH \
  --url http://localhost:3001/people/{peopleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inboxId": "<string>",
  "name": "<string>",
  "imageUrl": "<string>",
  "phoneNumber": "<string>",
  "document": "<string>",
  "description": "<string>",
  "country": "<string>",
  "city": "<string>",
  "email": "<string>",
  "isBlocked": true,
  "tags": [
    "<string>"
  ]
}
'

200

"<string>"

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

Insira o token JWT no formato: Bearer {token}

Path Parameters

peopleId · string · required

Identificador único (CUID) da pessoa a ser atualizada.

Pattern: ^[cC][^\s-]{8,}$

Body

application/json

inboxId · string · required

Identificador da inbox; usado junto ao ID da pessoa para localizar o registro.

name · string

Novo nome de exibição.

imageUrl · string

URL da imagem de perfil ou avatar, se aplicável.

phoneNumber · string

Novo telefone; será normalizado como na criação.

document · string

Documento atualizado (opcional).

description · string

Descrição ou notas internas atualizadas.

country · string

País atualizado (opcional).

city · string

Cidade atualizada (opcional).

email · string

E-mail atualizado (opcional).

isBlocked · boolean

Altera o status de bloqueio do contato.

tags · string[]

Substitui as tags da pessoa pelos identificadores informados (lista completa na inbox).

Response

200

application/json

Confirmação textual da operação; em caso de sucesso, o valor retornado é ok.

Confirmação textual da operação; em caso de sucesso, o valor retornado é ok.