CadastraPessoa
POST
/APIServicos/CadastraPessoa
| Campo | Tipo | Descrição |
|---|---|---|
token | Varchar | Token de acesso do cliente |
tipoCadastro | Varchar | F (física) ou J (jurídica) |
nomeFantasia | Varchar | Nome fantasia da pessoa |
razaoSocial | Varchar | Razão social da pessoa |
tipoPessoa | Varchar | Tipo de pessoa pré cadastrado no sistema |
cpfCnpj | Varchar | CPF ou CNPJ |
email | Varchar | |
telefone | Varchar | Telefone |
modeloConvenio | Varchar | Modelo de convênio (referência pré cadastrado no sistema) |
endereco.cep | Varchar | CEP |
endereco.uf | Varchar | UF (sigla) |
endereco.cidade | Varchar | Cidade (nome da cidade) |
endereco.complemento | Varchar | Complemento |
endereco.bairro | Varchar | Bairro |
contatos[].nome | Varchar | Nome do contato |
contatos[].email | Varchar | E-mail do contato |
contatos[].telefone | Varchar | Telefone do contato |
contatos[].cobranca | Varchar | Cobrança, enviar S (sim) ou N (não) |
contatos[].representanteLegal | Varchar | Responsável legal, enviar S (sim) ou N (não) |
contatos[].cargo | Varchar | Cargo |
contatos[].area | Varchar | Área |
contatos[].documento | Varchar | Documento |
contatos[].criaUsuario | Varchar | S (Sim) N (Não), indica se o contato receberá e-mail para primeiro acesso da plataforma |
contatos[].contatoPadrao | Varchar | Contato padrão, enviar S (Sim) N (Não) |
unidade | Varchar | Unidade (referência pré cadastrada no sistema) |
| Campo | Tipo | Descrição |
|---|---|---|
status | Varchar | Informa o status do retorno Sucesso (não ocorreu erro) SucessoParcial (incluiu a pessoa porém houve erros em algum dado posterior) Erro (erro ao incluir pessoa) |
descricao | Varchar | Descrição do erro |
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/APIServicos/CadastraPessoa' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "",
"sdt_servico_cadastra_pessoa": {
"tipoCadastro": "F",
"nomeFantasia": "string",
"razaoSocial": "string",
"tipoPessoa": "string",
"cpfCnpj": "string",
"email": "string",
"telefone": "string",
"modeloConvenio": "string",
"unidade": "string",
"endereco": {
"endereco": "string",
"cep": "string",
"uf": "string",
"cidade": "string",
"complemento": "string",
"bairro": "string"
},
"contatos": [
{
"nome": "string",
"email": "string",
"telefone": "string",
"cobranca": "string",
"representanteLegal": "string",
"cargo": "string",
"area": "string",
"documento": "string",
"criaUsuario": "string",
"contatoPadrao": "string"
}
]
}
}'Response Response Example
{
"status": "SucessoParcial",
"erros": [
{
"descricao": "Erro ao incluir e-mail da pessoa."
}
]
}Modified at 2026-03-20 13:29:59