Incluir Conta

post https://{domain}.sintesesolucoes.com.br/SinOMS.API/pub/contas/incluir

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

🚧
Se alguma propriedade for omitida, será atribuído valor nulo ao campo correspondente. Para evitar atribuições nulas indesejadas, é recomendável enviar o objeto com todas as suas propriedades e valores de forma explícita.

{
  "conta": "string",
  "site": "string",
  "chave": "string",
  "email": "string",
  "inativo": true,
  "acessoAdmin": true,
  "nomeRemetente": "string",
  "endereco": "string",
  "numero": "string",
  "complemento": "string",
  "bairro": "string",
  "cidade": "string",
  "uf": "string",
  "pais": "string",
  "cep": "string",
  "contaPrincipal": "string",
  "cnpj": "string",
  "tipoConta": "string",
  "telefone": "string",
  "inscricaoEstadual": "string",
  "utilizaMfa": true
}

Body Params

conta

string

required

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

site

string

required

Plataforma utilizada pela conta. ex: Wake/Vtex

chave

string

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

string

required

E-mail da conta

inativo

boolean

required

Defaults to true

Indica se a conta está inativa

acessoAdmin

boolean

required

Defaults to true

Indica se a conta possui acesso administrativo.

nomeRemetente

string

Nome do remetente do endereço.

endereco

string

Descrição do endereço.

numero

string

Número do endereço.

complemento

string

Complemento do endereço.

bairro

string

Nome do bairro.

cidade

string

Nome da cidade.

string

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

pais

string

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

cep

string

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

contaPrincipal

string

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

cnpj

string

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

tipoConta

string

Descrição do tipo da conta.

telefone

string

Telefone de contato da conta.

inscricaoEstadual

string

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

utilizaMfa

boolean

Defaults to true

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

Headers

string

Defaults to */*

Content-Type

string

Defaults to application/json

Responses

🚧

Se alguma propriedade for omitida, será atribuído valor nulo ao campo correspondente. Para evitar atribuições nulas indesejadas, é recomendável enviar o objeto com todas as suas propriedades e valores de forma explícita.

200200

400400

401401

403403