v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Empresa/Organização

Inserir Empresa/Organização

Esta seção está atrelada ao cadastro de uma empresa/organização, fazendo referência aos dados que deverão ser inseridos no ato da criação. + Campos utilizados para realizar a inserção da empresa/organização: + Campos utilizados para o Custom Fields (campos personalizados) entrar com o value, o identificador da opção ou ambos. Qualquer uma das situações são aceitáveis. + Campos obrigatórios: + Campo de parametrização: Caso contrário, se for false, ignora a validação e permite o cadastro com duplicidade. + Campos que o sistema valida a duplicidade :

post/organizationAdd

Request body

duplicityValidationboolean
namestring

Referente ao nome da empresa/organização

userEmailstring

Email do usuário vinculado ao cadastro da empresa/organização

cpfCnpjstring

CPF ou CNPJ da empresa/organização

websitestring

Referente ao site da empresa/organização

ddiPhonestring

DDI do país em questão

phonestring

DDD + Telefone da empresa/organização sem o 0

ddiPhone2string

Segunda opção do DDI do país em questão

phone2string

DDD + Segunda opção de telefone da empresa/organização sem o 0

addressstring

Endereço da empresa/organização

addressComplementstring

Complemento do endereço, caso tenha

zipcodestring

Refere-se ao CEP ou o código da região que a empresa/organização se encontra

citystring

A cidade que a empresa/organização se encontra

statestring

O Estado desta

countrystring

País que a empresa/organização se localiza

descriptionstring

Qualquer observação que se deseja fazer a respeito da empresa/organização que está sendo inserida.

idstring

identificação do campo personalizado

valuestring

valor do campo personalizado

Example request

{
  "organization": {
    "name": "Referente ao nome da empresa/organização",
    "userEmail": "usuario@spotter.com.br",
    "cpfCnpj": "12345678910112",
    "website": "www.exactsales.com.br",
    "ddiPhone": "55",
    "phone": "4830257750",
    "ddiPhone2": "55",
    "phone2": "48987654321",
    "address": "Rod. José Carlos Daux, 5500",
    "addressComplement": "123456",
    "zipcode": "88032005",
    "city": "Florianópolis",
    "state": "SC",
    "country": "Brasil",
    "description": "Qualquer observação que se deseja fazer a respeito da empresa/organização que está sendo inserida."
  }
}

Response

Recurso criado com sucesso