UsuáriosCriar Usuário

Criar Usuário

Cria um novo usuário na conta. Pode ser criado com senha direta ou via convite por e-mail (isInvite=true).

curl -X POST "https://api.amplifique.me/partners/users?isInvite=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{
  "name": "João da Silva",
  "email": "joao@example.com",
  "phone": "+5542999999999",
  "password": "MinhaSenh@123",
  "role": "pdv",
  "picture": "https://example.com/foto.jpg",
  "_businesses": [
    "6287abb2ec1259b0a5d75f99"
  ]
}'
{
  "_id": "6287aba50f06ef0bdf789aa2",
  "name": "João da Silva",
  "email": "joao@example.com",
  "active": true,
  "role": "pdv",
  "_empresa": "6287abaef6ee66d309ab00b1",
  "_businesses": [
    "6287abb2ec1259b0a5d75f99"
  ]
}
POST
/partners/users
POST
API Key (header: Authorization)
Authorizationstring
Required

API key (sent in header)

query
isInviteboolean
Required

Quando true, envia um convite por e-mail ao usuário (o campo password não é necessário nesse caso)

Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Nome completo do usuário

emailstring
Required

E-mail do usuário. Deve ser único — se já existir, a criação será recusada.

phonestring

Telefone do usuário (opcional)

passwordstring

Senha do usuário em texto plano. Obrigatório quando isInvite=false e não há SSO configurado.

rolestring
Required

Perfil de acesso: readonly (somente leitura), pdv (ponto de venda), ana (analista), adm (administrador), own (proprietário)

Options: readonly, pdv, ana, adm, own
picturestring

URL da foto de perfil do usuário

_businessesarray
Required

IDs das unidades às quais o usuário terá acesso. Se enviado vazio, será adicionado a todas as unidades.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

API Key for authentication. Provide your API key in the header.

Query Parameters

isInviteboolean
Required

Quando true, envia um convite por e-mail ao usuário (o campo password não é necessário nesse caso)

Body

application/json
namestring
Required

Nome completo do usuário

emailstring
Required

E-mail do usuário. Deve ser único — se já existir, a criação será recusada.

phonestring

Telefone do usuário (opcional)

passwordstring

Senha do usuário em texto plano. Obrigatório quando isInvite=false e não há SSO configurado.

rolestring
Required

Perfil de acesso: readonly (somente leitura), pdv (ponto de venda), ana (analista), adm (administrador), own (proprietário)

Allowed values:readonlypdvanaadmown
picturestring

URL da foto de perfil do usuário

_businessesarray
Required

IDs das unidades às quais o usuário terá acesso. Se enviado vazio, será adicionado a todas as unidades.

Responses

_idstring
namestring
emailstring
activeboolean
rolestring
_empresastring
_businessesstring[]