Criação

Método: POST

Nome/ObsTipoDescriçãoObrigatórioObservação
tokenStringToken para autenticaçãoN.T
nameStringNome da oportunidadeMínimo 2 caracteres
deal_stage_idStringID da etapa do funilEtapa do funil na qual a oportunidade será criada
deal_custom_fieldsObjetoCampos customizados da oportunidadeObrigatório, se o campo estiver marcado como obrigatório nas configurações do sistema
deal_sourceObjetoFonte da oportunidadeN.T
contactsLista (Objeto)Contatos associados a oportunidadeN.T
deal_productsLista (Objeto)Produtos vinculados a oportunidadePara associar um produto existente, basta enviar seu ID ou o nome, caso contrário será criado um novo produto.
campaignObjetoCampanha da oportunidadeN.T
organizationObjetoEmpresa à qual a oportunidade pertenceDentro deste objeto, há campos customizados. Verificar a estrutura de criação de empresa
userObjetoUsuário responsável pela oportunidadeN.T
holdBoleanoStatus da oportunidadeTrue se a negociação estiver pausada
ratingIntegerAvaliação da oportunidadeInteiro de 1 a 5
winBoleanoStatus da oportunidadeTrue se a oportunidade estiver ganha, False para perdida e Null para "em aberto"
prediction_dateDateData da previsão de fechamento da oportunidadeData prevista para o fechamento da oportunidade
deal_lost_reason_idStringID do motivo de fechamentoN.T
contacts.legal_baseArrayBase legal na estrutura proposta de base legal, conforme item XN.T

Estrutura em JSON da requisição:
{
  "token": "MY_TOKEN",
  "deal": {
    "name": "nome da oportunidade",
    "user_id": "ID_DO_RESPONSAVEL",
    "rating": 1,
    "deal_stage_id": "ID_DA_ETAPA_DO_FUNIL",
    "deal_custom_fields": [
      {
        "custom_field_id": "ID_DO_CAMPO_PERSONALIZADO",
        "value": "VALOR_DO_CAMPO"
      },
      {
        "custom_field_id": "ID_DO_CAMPO_PERSONALIZADO",
        "value": "VALOR_DO_CAMPO"
      }
    ]
  },
  "deal_products": [
    {
      "name": "Product 01",
      "description": "Description Product 1",
      "base_price": 199.91,
      "price": 199.91,
      "amount": 1,
      "total": 199.91,
      "discount_type": "value",
      "recurrence": "spare"
    },
    {
      "name": "Product 02",
      "description": "Description Product 2",
      "base_price": 199.92,
      "price": 199.92,
      "amount": 1,
      "total": 199.92,
      "discount_type": "value",
      "recurrence": "spare"
    }
  ],
  "contacts": [
    {
      "name": "Alexandre",
      "title": "Gerente",
      "facebook": "https://...",
      "linkedin": "http://...",
      "skype": "[email protected]",
      "birthday": {
        "day": 11,
        "month": 9,
        "year": 1979
      },
      "emails": [
        {
          "email": "[email protected]"
        },
        {
          "email": "[email protected]"
        }
      ],
      "phones": [
        {
          "phone": "3165585457",
          "type": "cellphone"
        }
      ],
      "legal_bases": [
        {
          "category": "data_processing",
          "type": "consent",
          "status": "granted"
        },
        {
          "category": "communications",
          "type": "vital_interest",
          "status": "granted"
        }
      ]
    }
  ],
  "deal_source": {
    "_id": "ID_DA_FONTE"
  },
  "campaign": {
    "_id": "ID_DA_CAMPANHA"
  },
  "organization": {
    "_id": "ID_DA_EMPRESA"
  }
}