Contas (Platform API)

Gerencie contas da plataforma NooviChat. Estes endpoints usam a Platform API e requerem autenticacao com api_access_token de nivel plataforma.

Platform API

Estes endpoints utilizam o prefixo /platform/api/v1 e requerem uma API key de plataforma, diferente do token de usuario.

POST/platform/api/v1/accounts

Cria uma nova conta (organizacao) na plataforma.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da conta/organizacao
`locale`	`string`	Nao	Idioma padrao (pt_BR, en, es)
`domain`	`string`	Nao	Dominio da empresa
`support_email`	`string`	Nao	Email de suporte

bash

curl -X POST "https://chat.seudominio.com/platform/api/v1/accounts" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Empresa ABC",
    "locale": "pt_BR",
    "domain": "empresaabc.com.br"
  }'

200Conta criada

json

{
  "id": 5,
  "name": "Empresa ABC",
  "locale": "pt_BR",
  "domain": "empresaabc.com.br",
  "created_at": "2026-02-15T10:00:00.000Z"
}

GET/platform/api/v1/accounts/{account_id}

Retorna os detalhes de uma conta especifica.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`account_id`(path)	`integer`	Sim	ID numerico da conta

bash

curl -s "https://chat.seudominio.com/platform/api/v1/accounts/5" \
  -H "api_access_token: PLATFORM_TOKEN" | jq .

200Detalhes da conta

json

{
  "id": 5,
  "name": "Empresa ABC",
  "locale": "pt_BR",
  "domain": "empresaabc.com.br",
  "status": "active"
}

PATCH/platform/api/v1/accounts/{account_id}

Atualiza os dados de uma conta existente.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome da conta
`locale`	`string`	Nao	Idioma
`domain`	`string`	Nao	Dominio
`support_email`	`string`	Nao	Email de suporte
`auto_resolve_duration`	`integer`	Nao	Tempo em minutos para auto-resolver conversas

bash

curl -X PATCH "https://chat.seudominio.com/platform/api/v1/accounts/5" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Empresa ABC Ltda", "auto_resolve_duration": 1440 }'

DELETE/platform/api/v1/accounts/{account_id}

Remove permanentemente uma conta e todos os seus dados.

bash

curl -X DELETE "https://chat.seudominio.com/platform/api/v1/accounts/5" \
  -H "api_access_token: PLATFORM_TOKEN"

Irreversivel

Esta acao remove permanentemente a conta, todas as conversas, contatos, inboxes e dados associados.

Usuarios da Conta

GET/platform/api/v1/accounts/{account_id}/account_users

Lista os usuarios associados a uma conta.

200Lista de usuarios

json

{
  "data": [
    { "id": 1, "user_id": 10, "role": "administrator" },
    { "id": 2, "user_id": 11, "role": "agent" }
  ]
}

POST/platform/api/v1/accounts/{account_id}/account_users

Adiciona um usuario a uma conta com uma role especifica.

Body

Nome	Tipo	Obrigatorio	Descricao
`user_id`	`integer`	Sim	ID do usuario
`role`	`string`	Sim	Role: administrator ou agent

bash

curl -X POST "https://chat.seudominio.com/platform/api/v1/accounts/5/account_users" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": 10, "role": "agent" }'

DELETE/platform/api/v1/accounts/{account_id}/account_users

Remove um usuario de uma conta.

Body

Nome	Tipo	Obrigatorio	Descricao
`user_id`	`integer`	Sim	ID do usuario a remover

bash

curl -X DELETE "https://chat.seudominio.com/platform/api/v1/accounts/5/account_users" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": 10 }'