Pular para o conteúdo

Usuarios (Platform API)

Gerencie usuarios da plataforma NooviChat. Estes endpoints usam a Platform API para criar, atualizar e gerenciar usuarios globais.

Platform API

Todos os endpoints usam o prefixo /platform/api/v1/users e requerem token de plataforma.

POST/platform/api/v1/users

Cria um novo usuario na plataforma.

Body

NomeTipoObrigatorioDescricao
namestringSimNome do usuario
emailstringSimEmail unico
passwordstringSimSenha (min 6 caracteres)
custom_attributesobjectNaoAtributos personalizados
bash
curl -X POST "https://chat.seudominio.com/platform/api/v1/users" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Santos",
    "email": "maria@empresa.com",
    "password": "senha_segura_123"
  }'
200Usuario criado
json
{
  "id": 10,
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "created_at": "2026-02-15T10:00:00.000Z"
}
GET/platform/api/v1/users/{id}

Retorna detalhes de um usuario.

bash
curl -s "https://chat.seudominio.com/platform/api/v1/users/10" \
  -H "api_access_token: PLATFORM_TOKEN" | jq .
PATCH/platform/api/v1/users/{id}

Atualiza dados de um usuario.

Body

NomeTipoObrigatorioDescricao
namestringNaoNome
emailstringNaoEmail
passwordstringNaoNova senha
custom_attributesobjectNaoAtributos personalizados
DELETE/platform/api/v1/users/{id}

Remove um usuario da plataforma.

bash
curl -X DELETE "https://chat.seudominio.com/platform/api/v1/users/10" \
  -H "api_access_token: PLATFORM_TOKEN"
GET/platform/api/v1/users/{id}/login

Gera um link SSO para login direto do usuario.

bash
curl -s "https://chat.seudominio.com/platform/api/v1/users/10/login" \
  -H "api_access_token: PLATFORM_TOKEN" | jq .
200Link de login SSO
json
{ "url": "https://chat.seudominio.com/auth/sign_in?token=sso_token_abc123" }