A Oportunidade é uma das três Entidades do RD Station CRM:
- Oportunidade
- Contato
- Empresa
Ela representa a possibilidade de negociar uma venda e contém todas as fases do processo de negociação.
Toda oportunidade cadastrada percorre o funil de vendas e, a cada atualização, as informações referentes ao avanço da negociação podem ser registradas em campos específicos.
Assim, todo o histórico de oportunidades, sejam elas ganhas (venda realizada) ou perdidas, fica armazenado no cadastro da Empresa à qual pertencem, independente do vendedor responsável e do tipo de produto ou serviço negociado.
Atenção
Toda informação cadastrada deve conter no mínimo 2 caracteres.
Query params
Parâmetros utilizados para listar e exibir Oportunidades.
| Nome | Tipo | Descrição |
|---|---|---|
| token | String | Token do usuário |
| deal_id | String | ID da oportunidade a ser exibida |
| page | String | Número da página listada. Valor padrão é 1 |
| limit | String | Limite de empresas que virão por listagem. Valor padrão é 20. Valor máximo é 200 |
| order | String | Ordenação. Valor padrão é "created_at". |
| direction | String | Ordenação da lista. "asc" ou "desc", padrão é "desc" |
| name | String | Nome da oportunidade |
| exact_name | String | Para buscas com nome exato, usar o parâmetro exact_name= true |
| win | String | Oportunidades ganhas. Com o valor true para trazer as oportunidades ganhas, false para trazer as oportunidades perdidas e null para retornar as oportunidades em aberto. |
| user_id | String | ID do usuário relacionado à oportunidade. |
| start_date | String | Primeiro dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period. Ex.: "start_date": "2020-12-14T15:00:00". |
| end_date | String | Último dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period. Ex.: "end_date": "2020-12-14T15:00:00" |
| closed_at | Boolean | Ao informar true, retorna as oportunidades GANHAS/PERDIDAS. Ao informar false, retorna as oportunidades EM ABERTO OU PAUSADAS. |
| closed_at_period | Boolean | Data de fechamento da deal: se true deve ser informado start_date e end_date. |
| created_at_period | Boolean | Data de criação da deal: se true, deve ser informado start_date e end_date |
| prediction_date_period | Boolean | Data de previsão de fechamento da oportunidade: se true, deve ser informado start_date e end_date |
| closed_by_id | String | ID do usuário que fechou a venda |
| deal_stage_id | String | ID da etapa |
| deal_lost_reason_id | String | ID do motivo de perda |
| organization | String | ID da empresa |
| hold | String | Estado da oportunidade pausada. Se marcado como true, retorna todas oportunidades pausadas. Para outros casos, não deve-se utilizar esse parâmetro. |
| product_presence | String | Oportunidades que contenham produtos/serviços relacionados: false (nenhum produto relacionado), true (um ou mais produtos relacionados) ou uma lista de IDs de produto. A lista de IDs deve ser informada com os valores separados por vírgula. Ex.: 5esdsds, d767dsdssd, c6e40fd2f000972a083. |
| deal_pipeline_id | String | ID do Funil |
Body params
Parâmetros utilizados para criar e atualizar Oportunidades.
| Nome | Tipo | Descrição | Obrigatório | Observação |
|---|---|---|---|---|
| name | String | Nome da oportunidade a ser exibida | ✓ | |
| deal_stage_id | String | ID da etapa do funil | ✘ | |
| deal_custom_fields | Object | Campos customizados da oportunidade | ✘ | |
| deal_source | Object | Fonte da oportunidade | ✘ | |
| contacts | Array of objects | Contatos associados a oportunidade | ✘ | |
| deal_products | Array of objects | Produtos vinculados a oportunidade | ✘ | |
| campaign | Object | Campanha da oportunidade | ✘ | |
| organization | Object | Empresa à qual a oportunidade pertence | ✘ | |
| user | Object | Usuário responsável pela oportunidade | ✓ | |
| hold | Boolean | Status da oportunidade | ✘ | Valores aceitos: paused (pausada), null (em aberto) |
| rating | Integer | Avaliação da oportunidade | ✘ | |
| win | Boolean | Status da oportunidade | ✘ | Valores aceitos: true (oportunidade ganha), false (oportunidade perdida), null (oportunidade em aberto) |
| prediction_date | Date | Data da previsão de fechamento da oportunidade | ✘ | Formato (yyyy-mm-dd) |
| deal_lost_reason_id | String | ID do motivo da perda | ✘ | |
| contacts.legal_base | Array | Base legal | ✘ |