Nome/Obs | Tipo | Descrição | Obrigatório | Observação |
---|
token | String | Token para autenticação | ✓ | N.T |
name | String | Nome da oportunidade | ✓ | Mínimo 2 caracteres |
deal_stage_id | String | ID da etapa do funil | ✘ | Etapa do funil na qual a oportunidade será criada |
deal_custom_fields | Objeto | Campos customizados da oportunidade | ✘ | Obrigatório, se o campo estiver marcado como obrigatório nas configurações do sistema |
deal_source | Objeto | Fonte da oportunidade | ✘ | N.T |
contacts | Lista (Objeto) | Contatos associados a oportunidade | ✘ | N.T |
deal_products | Lista (Objeto) | Produtos vinculados a oportunidade | ✘ | Para associar um produto existente, basta enviar seu ID ou o nome, caso contrário será criado um novo produto. |
campaign | Objeto | Campanha da oportunidade | ✘ | N.T |
organization | Objeto | Empresa à qual a oportunidade pertence | ✓ | Dentro deste objeto, há campos customizados. Verificar a estrutura de criação de empresa |
user | Objeto | Usuário responsável pela oportunidade | ✓ | N.T |
hold | Boleano | Status da oportunidade | ✘ | True se a negociação estiver pausada |
rating | Integer | Avaliação da oportunidade | ✘ | Inteiro de 1 a 5 |
win | Boleano | Status da oportunidade | ✘ | True se a oportunidade estiver ganha, False para perdida e Null para "em aberto" |
prediction_date | Date | Data da previsão de fechamento da oportunidade | ✘ | Data prevista para o fechamento da oportunidade |
deal_lost_reason_id | String | ID do motivo de fechamento | ✘ | N.T |
contacts.legal_base | Array | Base legal na estrutura proposta de base legal, conforme item X | ✘ | N.T |
{
"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]email.com",
"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"
}
}