Cria um usuário

POST

/api/v2/users

• Servidor do ambiente de produção
• Servidor do ambiente de testes

Cria um usuário

Authorizations

• Token
• X-Shop-Host

Request Body

Campos de cadastro de usuário

Modelo que representa o cadastro de usuário

object

email

required

Email do usuário

string format: email

name

Nome do usuário

string

nullable

role_name

Função do usuário na loja

string

Allowed values: Agente Gestor Local Agente Social Selling

password

Senha do usuário

string

password_confirmation

Confirmação de senha do usuário

string

external_code

Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema.

string

phone_area

Código de Discagem Direta a Distância (DDD) do telefone do usuário

string

>= 2 characters <= 2 characters

phone

Número de telefone do usuário

string

>= 8 characters <= 9 characters

tags

Tags para agrupamento de usuários Com as tags o lojista pode agrupar usuários para direcionar promoções para determinados usuários, fazer uma divisão de pagamentos, definir regras de comissão, entre outras aplicações com usuários

Array<string>

Responses

201

Usuário criado

Informações de retorno de usuário

Modelo que representa um usuário

object

id

Código identificador do usuário

integer

email

Email do usuário

string format: email

access_token

Token de validação de usuário logado (access_token)

O access_token é gerado quando o usuário loga no Admin

string

name

Nome do usuário

string

nullable

admin

Identificador de usuários administradores

Esse atributo retorna true para um usuário administrador do ambiente de loja

boolean

renew_password

Identificador de usuários que atualizaram a senha inicial

Esse atributo retorna true para um usuário que já redefiniu sua senha pelo menos uma vez

boolean

role

Código da função do usuário na loja:

• Agente: 0;
• Gestor: 1;
• Local: 2;
• Agente Social Selling: 3.

integer

tags

Tags para agrupamento de usuários As tags podem ser são utilizadas para direcionar promoções para determinados usuários, organizar os recebedores em uma divisão de pagamentos, definir regras de comissão

Array<string>

external_code

Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema.

string

nullable

phone_area

Código de Discagem Direta a Distância (DDD) do telefone do usuário

string

>= 2 characters <= 2 characters

phone

Número de telefone do usuário

string

>= 8 characters <= 9 characters

created_at

Data de inclusão do usuário no Admin

string format: date-time

updated_at

Data de atualização das informações do usuário

string format: date-time

422

Parâmetros inválidos

422

Erro de validação na criação e atualização de registros

object

errors

object

{field}

Array<string>