Sign in

v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Adicionar empresa

post/companies

Request body

namestring required

Nome da empresa.

city_idinteger

ID da cidade da empresa.

manager_idinteger

ID da conta do usuário CS responsável.

segment_idinteger

ID do segmento de negócio da empresa.

cnae_idinteger

ID do CNAE principal da empresa.

cnpjstring

CNPJ da empresa. Formatos aceitos: "XXXXXXXX0001XX" e "XX.XXX.XXX/0001-XX".

websitestring

URL do website da empresa.

email_nfstring

E-mail da empresa para envio de nota fiscal.

logostring

URL apontando para logomarca da empresa.

observationstring

Observações sobre a empresa.

address_postal_codestring

Código postal da empresa.

addressstring

Rua da empresa.

address_numberstring

Número do endereço da empresa.

address_complementstring

Complemento do endereço da empresa.

company_namestring

Nome da empresa.

iestring

Número da inscrição estadual da empresa.

districtstring

Bairro do endereço da empresa.

countrystring

País do endereço da empresa.

facebookstring

URL da página do Facebook da empresa.

linkedinstring

URL da página do Linkedin da empresa.

customer_atstring date

Data em que a empresa se tornou cliente.

foundation_atstring date

Data da fundação da empresa.

company_typeinteger

Tipo de empresa: 1: Cliente, 2: Fornecedor, 3: Franquia, 4: Transportadora, 5: Canais.

company_situationinteger

Situação da empresa: 1: lead, 2: lead suspect, 3: lead qualificado de marketing (MQL), 4: lead qualificado de vendas (SQL), 5: lead aceito por vendas (SAL), 6: lead prospects (OPs), 7: cliente ativo, 8: cliente inativo, 9: cliente perdido.

status_touchstring

Modelo touch da empresa: 1: high touch, 2: middle touch, 3: low touch, 4: tech touch, 5: now touch.

nps_scoreinteger

Pontuação NPS da empresa.

legal_naturestring

Natureza jurídica da empresa. Campo preenchido automaticamente pela busca de CNPJ.

social_capitalnumber float

Capital Social da empresa.

is_brandboolean

Define o tipo de empresa: true: empresa é uma marca.

is_supplierboolean

Define o tipo de empresa: true: empresa é fornecedora.

is_clientboolean

Define o tipo de empresa: true: empresa é cliente.

is_carrierboolean

Define o tipo de empresa: true: empresa é transportadora.

is_franchiseboolean

Define o tipo de empresa: true: empresa é franquia.

is_channelboolean

Define o tipo de empresa: true: empresa é canal de venda.

is_distributorboolean

Define o tipo de empresa: true: empresa é distribuidora.

is_manufacturerboolean

Define o tipo de empresa: true: empresa é fabricante.

is_partnerboolean

Define o tipo de empresa: true: empresa é parceira.

hashstring

Hash identificadora da empresa.

cityobject

Objeto de Cidade.

external_codestring

Código externo, utilizado para integrações com outras ferramentas.

statusboolean

Situação cadastral da empresa: false: empresa desativada, true: empresa ativada.

company_statusboolean

Status da empresa: 1: lead, 2: cliente.

foreign_contactboolean

Identifica se a empresa é estrangeira: true: empresa é estrangeira.

sizestring

Porte da empresa.

Response

201

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Created",
  "data": [
    {
      "id": 748,
      "account_id": 748,
      "cnae_id": 748,
      "city_id": 748,
      "owner_id": 748,
      "manager_id": 748,
      "segment_id": 748,
      "name": "Teste",
      "website": "https://example.org/company",
      "email_nf": "adm@odig.net",
      "logo": "https://example.org/logo.png",
      "hash": "ccef1438a94a1987539f0767bbda403c",
      "address_postal_code": "90560-002",
      "address": "Av. Cristóvão Colombo, 2948",
      "address_number": "12",
      "company_name": "odig",
      "ie": "473.710.660.535",
      "district": "centro",
      "country": "Brasil",
      "city": {
        "id": 1,
        "uf": "RO",
        "name": "Alta Floresta D'Oeste"
      },
      "cep": "90560-002",
      "customer_at": "2020-02-19",
      "foundation_at": "2020-02-19",
      "company_type": "1",
      "company_status": 1,
      "company_situation": 1,
      "status_touch": 1,
      "nps_score": 11222,
      "social_capital": 111111,
      "is_brand": true,
      "is_supplier": true,
      "is_client": true,
      "is_carrier": true,
      "is_franchise": true,
      "lat": 1,
      "lng": 1,
      "status": 1,
      "external_code": 1,
      "size": 1,
      "contact_emails": {
        "id": 1,
        "account_id": 748,
        "company_id": 748,
        "person_id": 748,
        "is_main": 1,
        "type": "Comercial",
        "email": "email@odig.net"
      }
    }
  ]
}