Sign in

v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Adicionar meta avançada

post/advanced-goals

Request body

titlestring required

Título

visibilityinteger required

Visibilidade. Opções: 1= pública | 2= privada | 3= envolvidos

typeinteger required

Tipo. Opções: 1= oportunidade | 2= atividade | 3= forecast | 4= proposta | 5= ligação | 6= assinatura

goal_forinteger

Meta por. Opções: 1= quantidade | 2= valor | 5= duração. Obrigatório quando type for: 1, 4 ou 5

observationstring

Observação

type_of_periodinteger required

Vigência da meta por. Opções: 0= período customizado | 1= dia | 2= semana | 3= duas semanas | 4= mês | 5= bimestre | 6= trimestre | 7= semestre | 8= ano

start_atstring date required

Inicia em (Ex.: 2025-01-01). Padrão: aaaa-mm-dd

end_atstring date required

Termina em (Ex.: 2025-01-01). Padrão: aaaa-mm-dd

item_criteriainteger

Filtrar por. Opções: 1= categoria | 2= item | 3= tipo de item

item_idinteger

ID do item. Obrigatório quando item_criteria for: 2

item_categoriesinteger[]

Array de ID de categoria do item. Obrigatório quando item_criteria for: 1

item_criteriasstring[]

Array de tipo de item. Opções: product= Produto | service= Serviço | mrr= MRR | ps= P&S. Obrigatório quando item_criteria for: 3

item_criterias_instring[]

Array de filtrar em. Opções: proposals= Itens da proposta | deals= Itens da oportunidade

activity_type_idinteger

ID do tipo de atividade. Disponível quando type for: 2

origin_idinteger

ID da origem da oportunidade

region_idinteger

ID da região/microrregião de empresa/pessoa

city_idinteger

ID da cidade da empresa/pessoa

statestring

UF da cidade da empresa/pessoa. Ex.: SP, RJ, RS

segment_idinteger

ID do segmento da empresa

deal_statusstring[]

Array de status das oportunidades. Opções: open= Abertas | closed= Ganhas

proposal_statusstring[]

Array de status das propostas. Disponível quando type for: 4. Opções: open= Aberta | approved= Aprovada | sent_to_sign= Aguardando assinatura | signed= Assinada

deal_value_forstring[]

Array de tipo de valor. Disponível quando type for: 1, goal_for for: 2 e item_criteria não for: 3. Opções: P&S | MRR

activity_statusstring[]

Array de status das atividades. Disponível quando type for: 2. Opções: open= Abertas | done= Concluídas

call_relevancestring[]

Array de relevância da ligação. Disponível quando type for: 5. Opções: import= Relevantes | not_important= Irrelevantes

signature_statusstring[]

Array de status das assinaturas. Disponível quando type for: 6. Opções: sent_to_sign= Enviado para assinatura | signed_by_all= Assinado por todos

pipelinesinteger[]

Filtro de ID de funil

stagesinteger[]

Filtro de ID de etapa

tagsinteger[]

Filtro de ID de tag

Response

200