Skip to main content
POST
/
user
Criar usuário
curl --request POST \
  --url http://localhost:3001/user/ \
  --header 'Content-Type: application/json' \
  --header 'X-JuriChat-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "password": "<string>",
  "contact": "<string>",
  "officeId": "<string>",
  "roleId": "<string>",
  "inboxId": [
    "<string>"
  ],
  "imageUrl": "<string>",
  "notificationSound": "tick.mp3",
  "onlyAssignedConversations": false
}
'
{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "contact": "<string>",
  "imageUrl": "<string>",
  "notificationSound": "<string>",
  "officeId": "<string>",
  "roleId": "<string>",
  "inboxes": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "lastInboxUsed": "<string>",
  "onlyAssignedConversations": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

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 completo do usuário.

Minimum string length: 1
email
string<email>
required

E-mail de acesso (único no escritório).

password
string
required

Senha de acesso. Mínimo de 6 caracteres.

Minimum string length: 6
contact
string
required

Telefone ou WhatsApp do usuário.

Minimum string length: 1
officeId
string
required

ID do escritório ao qual o usuário pertence.

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

ID do papel inicial do usuário.

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

IDs das inboxes às quais o usuário terá acesso.

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

URL de avatar. Opcional.

notificationSound
string
default:tick.mp3

Arquivo de som para notificações. Padrão: tick.mp3.

onlyAssignedConversations
boolean
default:false

Quando verdadeiro, o usuário visualiza apenas conversas atribuídas a ele. Padrão: false.

Response

Default Response

id
string
required

ID do usuário criado.

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

Nome do usuário.

email
string
required

E-mail de acesso.

contact
string
required

Telefone ou WhatsApp cadastrado.

imageUrl
string | null
required

URL de avatar. Null se não definido.

notificationSound
string
required

Arquivo de som de notificação.

officeId
string
required

ID do escritório ao qual o usuário pertence.

roleId
string
required

ID do papel atribuído ao usuário.

inboxes
object[]
required

Inboxes associadas ao usuário no momento da criação.

lastInboxUsed
string | null
required

ID da última inbox utilizada. Null se não houver.

onlyAssignedConversations
boolean
required

Indica se o usuário visualiza apenas conversas atribuídas a ele.

createdAt
string<date-time>
required

Data e hora de criação.