v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Incluir Conta

Endpoint público para inclusão de uma nova conta no Wake OMS

post/pub/contas/incluir

Headers

Acceptstring

Content-Typestring

Request body

contastring required

Nome da conta do usuário. Evitar uso de acentos e espaços

sitestring required

Plataforma utilizada pela conta. ex: Wake

chavestring

Identificação de acesso à plataforma/integrações

emailstring required

E-mail da conta

inativoboolean required

Indica se a conta está inativa

acessoAdminboolean required

Indica se a conta possui acesso administrativo.

nomeRemetentestring

Nome do remetente do endereço.

enderecostring

Descrição do endereço.

numerostring

Número do endereço.

complementostring

Complemento do endereço.

bairrostring

Nome do bairro.

cidadestring

Nome da cidade.

ufstring

Uf do endereço. Exemplo: São Paulo = SP, Rio de Janeiro = RJ, Minas Gerais = MG etc...

paisstring

Nome do País. Exemplo: Brasil, Suíça, Noruega, Islândia etc...

cepstring

Cep do endereço. Exemplo: 99999-999 (Com traços).

contaPrincipalstring

Indica qual é o nome da conta principal. Não é necessario informar se for conta administrativa

cnpjstring

Número do CNPJ. Exemplo: 99999999999999 (14 posições, completando com zero à esquerda, sem ponto, sem barra e sem traço).

tipoContastring

Descrição do tipo da conta.

telefonestring

Telefone de contato da conta.

inscricaoEstadualstring

Número da inscrição estadual. Exemplo: 042274439 (Sem ponto, sem barra e sem traço).

utilizaMfaboolean

Indica se a conta utiliza ou não múltiplo fator de autenticação.

Response

200

mensagemstring

{"stackTrail":"paths:/pub/contas/incluir:post:responses:200:content:application/json:schema:properties:dados","oasType":"schema","type":"unknown"}

Example response

{
  "mensagem": "Conta xxx incluída com sucesso."
}