Nesta área

Marketing Funnels

List lead-capture funnels

get/v1/public/marketing-funnels

Parâmetros

Sem parâmetros.

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Create a lead-capture funnel

post/v1/public/marketing-funnels

Aceita Idempotency-Key

Parâmetros

Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

namestringobrigatório
descriptionstringopcional
stagesobject[]opcional
stages[].idstringopcional
stages[].namestringobrigatório
stages[].ordernumberobrigatório
stages[].colorstringopcional
stages[].isInitialbooleanopcional
stages[].isGoalbooleanopcional
staleDaysnumberopcional: Auto-lose cards idle for this many days (null/omitted = disabled).
autoCreateDealbooleanopcional: Ganhar um card cria um negócio no funil de vendas.
dealStageIdstringopcional: Estágio do pipeline onde o negócio nasce (null = primeiro da organização).

Campo	Tipo	Descrição
`name`obrigatório	string
`description`opcional	string
`stages`opcional	object[]
`stages[].id`opcional	string
`stages[].name`obrigatório	string
`stages[].order`obrigatório	number
`stages[].color`opcional	string
`stages[].isInitial`opcional	boolean
`stages[].isGoal`opcional	boolean
`staleDays`opcional	number	Auto-lose cards idle for this many days (null/omitted = disabled).
`autoCreateDeal`opcional	boolean	Ganhar um card cria um negócio no funil de vendas.
`dealStageId`opcional	string	Estágio do pipeline onde o negócio nasce (null = primeiro da organização).

Respostas

201

Exemplos

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/marketing-funnels" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Maria Souza",
  "description": "texto",
  "stages": [
    {
      "id": "id_123",
      "name": "Maria Souza",
      "order": 0,
      "color": "texto",
      "isInitial": true,
      "isGoal": true
    }
  ],
  "staleDays": 1,
  "autoCreateDeal": true,
  "dealStageId": "dealStage_123"
}'

Get a funnel lead timeline

get/v1/public/marketing-funnels/leads/{cardId}/timeline

Parâmetros

cardIdstringobrigatório· caminho: Funnel lead/card ID

Campo	Onde	Tipo	Descrição
`cardId`obrigatório	caminho	string	Funnel lead/card ID

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels/leads/<cardId>/timeline" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Move a funnel lead to another stage

patch/v1/public/marketing-funnels/leads/{cardId}/move

Aceita Idempotency-Key

Parâmetros

cardIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`cardId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

stageIdstringobrigatório
positionnumberopcional

Campo	Tipo	Descrição
`stageId`obrigatório	string
`position`opcional	number

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/marketing-funnels/leads/<cardId>/move" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "stageId": "stage_123",
  "position": 0
}'

Update a funnel lead status or value

patch/v1/public/marketing-funnels/leads/{cardId}

Aceita Idempotency-Key

Parâmetros

cardIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`cardId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

statusstringopcional: ACTIVEWONLOST
lostReasonstringopcional: Why the card was lost (stored when status becomes LOST).
estimatedValuenumberopcional: Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Campo	Tipo	Descrição
`status`opcional	string	`ACTIVEWONLOST`
`lostReason`opcional	string	Why the card was lost (stored when status becomes LOST).
`estimatedValue`opcional	number	Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/marketing-funnels/leads/<cardId>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "status": "ACTIVE",
  "lostReason": "texto",
  "estimatedValue": 0
}'

Delete a funnel lead

delete/v1/public/marketing-funnels/leads/{cardId}

Parâmetros

cardIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`cardId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

204

Exemplos

bash

curl -X DELETE "https://api.cognizy.ai/api/v1/public/marketing-funnels/leads/<cardId>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Update a funnel transition rule

patch/v1/public/marketing-funnels/rules/{ruleId}

Aceita Idempotency-Key

Parâmetros

ruleIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`ruleId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

namestringopcional
triggerobjectopcional
fromStageIdstringopcional
toStageIdstringopcional
conditionsobject[]opcional
conditions[].fieldstringobrigatório: messageBodychanneltagNameemailTypeidleDays
conditions[].operatorstringobrigatório: existsequalsnot_equalscontainsgtelte
conditions[].valueobjectopcional
actionsobject[]opcional
actions[].typestringobrigatório: add_tagsend_webhookmark_lostnotify
actions[].paramsobjectopcional
isActivebooleanopcional
ordernumberopcional

Campo	Tipo	Descrição
`name`opcional	string
`trigger`opcional	object
`fromStageId`opcional	string
`toStageId`opcional	string
`conditions`opcional	object[]
`conditions[].field`obrigatório	string	`messageBodychanneltagNameemailTypeidleDays`
`conditions[].operator`obrigatório	string	`existsequalsnot_equalscontainsgtelte`
`conditions[].value`opcional	object
`actions`opcional	object[]
`actions[].type`obrigatório	string	`add_tagsend_webhookmark_lostnotify`
`actions[].params`opcional	object
`isActive`opcional	boolean
`order`opcional	number

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/marketing-funnels/rules/<ruleId>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Maria Souza",
  "trigger": {},
  "fromStageId": "fromStage_123",
  "toStageId": "toStage_123",
  "conditions": [
    {
      "field": "messageBody",
      "operator": "exists",
      "value": {}
    }
  ],
  "actions": [
    {
      "type": "add_tag",
      "params": {}
    }
  ],
  "isActive": true,
  "order": 1
}'

Delete a funnel transition rule

delete/v1/public/marketing-funnels/rules/{ruleId}

Parâmetros

ruleIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`ruleId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

204

Exemplos

bash

curl -X DELETE "https://api.cognizy.ai/api/v1/public/marketing-funnels/rules/<ruleId>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Get a funnel stage cadence

get/v1/public/marketing-funnels/stages/{stageId}/cadence

Parâmetros

stageIdstringobrigatório· caminho

Campo	Onde	Tipo	Descrição
`stageId`obrigatório	caminho	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels/stages/<stageId>/cadence" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Create or replace a funnel stage cadence

put/v1/public/marketing-funnels/stages/{stageId}/cadence

Parâmetros

stageIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`stageId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

isActivebooleanopcional
onExhaustobjectobrigatório
onExhaustStageIdstringopcional
stepsobject[]obrigatório
steps[].idstringopcional
steps[].ordernumberobrigatório
steps[].delayMinutesnumberobrigatório: Delay from the previous step (or stage entry for the first step), in minutes.
steps[].channelobjectobrigatório
steps[].subjectstringopcional
steps[].bodystringobrigatório
steps[].templateIdstringopcional
steps[].isBreakupbooleanopcional

Campo	Tipo	Descrição
`isActive`opcional	boolean
`onExhaust`obrigatório	object
`onExhaustStageId`opcional	string
`steps`obrigatório	object[]
`steps[].id`opcional	string
`steps[].order`obrigatório	number
`steps[].delayMinutes`obrigatório	number	Delay from the previous step (or stage entry for the first step), in minutes.
`steps[].channel`obrigatório	object
`steps[].subject`opcional	string
`steps[].body`obrigatório	string
`steps[].templateId`opcional	string
`steps[].isBreakup`opcional	boolean

Respostas

200

Exemplos

bash

curl -X PUT "https://api.cognizy.ai/api/v1/public/marketing-funnels/stages/<stageId>/cadence" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "isActive": true,
  "onExhaust": {},
  "onExhaustStageId": "onExhaustStage_123",
  "steps": [
    {
      "id": "id_123",
      "order": 0,
      "delayMinutes": 0,
      "channel": {},
      "subject": "texto",
      "body": "texto",
      "templateId": "template_123",
      "isBreakup": true
    }
  ]
}'

Delete a funnel stage cadence

delete/v1/public/marketing-funnels/stages/{stageId}/cadence

Parâmetros

stageIdstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`stageId`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

204

Exemplos

bash

curl -X DELETE "https://api.cognizy.ai/api/v1/public/marketing-funnels/stages/<stageId>/cadence" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

List and filter funnel leads

get/v1/public/marketing-funnels/{id}/leads

Parâmetros

idstringobrigatório· caminho
limitnumberopcional· consulta
pagenumberopcional· consulta
inactiveDaysnumberopcional· consulta
campaignIdstringopcional· consulta
minLeadScorenumberopcional· consulta
statusACTIVE | WON | LOST | STALLEDopcional· consulta
stageIdstringopcional· consulta

Campo	Onde	Tipo
`id`obrigatório	caminho	string
`limit`opcional	consulta	number
`page`opcional	consulta	number
`inactiveDays`opcional	consulta	number
`campaignId`opcional	consulta	string
`minLeadScore`opcional	consulta	number
`status`opcional	consulta	ACTIVE \| WON \| LOST \| STALLED
`stageId`opcional	consulta	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>/leads" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Create a lead in a funnel

post/v1/public/marketing-funnels/{id}/leads

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

contactIdstringobrigatório
stageIdstringopcional
campaignIdstringopcional
estimatedValuenumberopcional: Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Campo	Tipo	Descrição
`contactId`obrigatório	string
`stageId`opcional	string
`campaignId`opcional	string
`estimatedValue`opcional	number	Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Respostas

201

Exemplos

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>/leads" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "contactId": "contact_123",
  "stageId": "stage_123",
  "campaignId": "campaign_123",
  "estimatedValue": 0
}'

Get deterministic funnel insights

get/v1/public/marketing-funnels/{id}/insights

Parâmetros

idstringobrigatório· caminho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>/insights" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

List funnel transition rules

get/v1/public/marketing-funnels/{id}/rules

Parâmetros

idstringobrigatório· caminho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>/rules" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Create a funnel transition rule

post/v1/public/marketing-funnels/{id}/rules

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

namestringobrigatório
triggerobjectobrigatório
fromStageIdstringopcional
toStageIdstringobrigatório
conditionsobject[]opcional
conditions[].fieldstringobrigatório: messageBodychanneltagNameemailTypeidleDays
conditions[].operatorstringobrigatório: existsequalsnot_equalscontainsgtelte
conditions[].valueobjectopcional
actionsobject[]opcional
actions[].typestringobrigatório: add_tagsend_webhookmark_lostnotify
actions[].paramsobjectopcional
ordernumberopcional

Campo	Tipo	Descrição
`name`obrigatório	string
`trigger`obrigatório	object
`fromStageId`opcional	string
`toStageId`obrigatório	string
`conditions`opcional	object[]
`conditions[].field`obrigatório	string	`messageBodychanneltagNameemailTypeidleDays`
`conditions[].operator`obrigatório	string	`existsequalsnot_equalscontainsgtelte`
`conditions[].value`opcional	object
`actions`opcional	object[]
`actions[].type`obrigatório	string	`add_tagsend_webhookmark_lostnotify`
`actions[].params`opcional	object
`order`opcional	number

Respostas

201

Exemplos

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>/rules" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Maria Souza",
  "trigger": {},
  "fromStageId": "fromStage_123",
  "toStageId": "toStage_123",
  "conditions": [
    {
      "field": "messageBody",
      "operator": "exists",
      "value": {}
    }
  ],
  "actions": [
    {
      "type": "add_tag",
      "params": {}
    }
  ],
  "order": 1
}'

Get a lead-capture funnel

get/v1/public/marketing-funnels/{id}

Parâmetros

idstringobrigatório· caminho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Update a lead-capture funnel

patch/v1/public/marketing-funnels/{id}

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Corpo (JSON)obrigatório

namestringopcional
descriptionstringopcional
isActivebooleanopcional
staleDaysnumberopcional: Auto-lose cards idle for this many days; null disables the behavior.
autoCreateDealbooleanopcional: Ganhar um card cria um negócio no funil de vendas.
dealStageIdstringopcional: Estágio do pipeline onde o negócio nasce (null = primeiro da organização).
stagesobject[]opcional: Full replace of the stage set (creates/updates/removes to match).
stages[].idstringopcional
stages[].namestringobrigatório
stages[].ordernumberobrigatório
stages[].colorstringopcional
stages[].isInitialbooleanopcional
stages[].isGoalbooleanopcional

Campo	Tipo	Descrição
`name`opcional	string
`description`opcional	string
`isActive`opcional	boolean
`staleDays`opcional	number	Auto-lose cards idle for this many days; null disables the behavior.
`autoCreateDeal`opcional	boolean	Ganhar um card cria um negócio no funil de vendas.
`dealStageId`opcional	string	Estágio do pipeline onde o negócio nasce (null = primeiro da organização).
`stages`opcional	object[]	Full replace of the stage set (creates/updates/removes to match).
`stages[].id`opcional	string
`stages[].name`obrigatório	string
`stages[].order`obrigatório	number
`stages[].color`opcional	string
`stages[].isInitial`opcional	boolean
`stages[].isGoal`opcional	boolean

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Maria Souza",
  "description": "texto",
  "isActive": true,
  "staleDays": 1,
  "autoCreateDeal": true,
  "dealStageId": "dealStage_123",
  "stages": [
    {
      "id": "id_123",
      "name": "Maria Souza",
      "order": 0,
      "color": "texto",
      "isInitial": true,
      "isGoal": true
    }
  ]
}'

Delete a lead-capture funnel

delete/v1/public/marketing-funnels/{id}

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

204

Exemplos

bash

curl -X DELETE "https://api.cognizy.ai/api/v1/public/marketing-funnels/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Toda a referência