Skip to main content
POST
/
people
Criar contato
curl --request POST \
  --url http://localhost:3001/people/ \
  --header 'Content-Type: application/json' \
  --header 'X-JuriChat-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "phoneNumber": "<string>",
  "inboxId": "<string>",
  "isBlocked": true,
  "email": "<string>",
  "document": "<string>",
  "description": "<string>",
  "country": "<string>",
  "city": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "phoneNumber": "<string>",
  "isBlocked": true,
  "inboxId": "<string>",
  "email": "<string>",
  "document": "<string>",
  "description": "<string>",
  "country": "<string>",
  "city": "<string>",
  "tags": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-JuriChat-Api-Key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header X-JuriChat-Api-Key.

Body

application/json
name
string
required

Nome do contato.

phoneNumber
string
required

Número de telefone do contato.

inboxId
string
required

ID da inbox à qual o contato será vinculado.

isBlocked
boolean
required

Define se o contato começa bloqueado.

email
string

E-mail do contato. Opcional.

document
string

CPF, CNPJ ou outro documento. Opcional.

description
string

Anotações sobre o contato. Opcional.

country
string

País. Opcional.

city
string

Cidade. Opcional.

tags
string[]

IDs de tags existentes na inbox. Omitir para criar sem tags.

Response

Default Response

id
string
required

ID do contato criado.

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

Nome do contato.

phoneNumber
string
required

Número de telefone do contato.

isBlocked
boolean
required

Indica se o contato está bloqueado.

inboxId
string
required

ID da inbox à qual o contato pertence.

email
string

E-mail do contato. Omitido se não informado.

document
string

Documento do contato. Omitido se não informado.

description
string

Anotações sobre o contato. Omitido se não informado.

country
string

País. Omitido se não informado.

city
string

Cidade. Omitida se não informada.

tags
string[]

IDs das tags associadas ao contato.