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_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 |
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 |
deal_stage_id | String | ID da etapa do funil | ✘ | N.T |
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 |
{
"token": "MY_TOKEN",
"deal": {
"name": "nome da oportunidade",
"amount_montly": 0,
"amount_unique": 0,
"prediction_date": null,
"win": null,
"rating": 1,
"hold": null,
"user": {
"_id": "ID_DO_USUARIO"
},
"organization": {
"_id": "ID_DA_EMPRESA"
},
"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_stage_id": "ID_DA_ETAPA",
"deal_source": {
"_id": "ID_DA_FONTE"
},
"campaign": {
"_id": "ID_DA_CAMPANHA"
},
"deal_lost_reason": {
"_id": "ID_DO_MOTIVO_DE_PERDA"
}
}