In this area

Marketing Funnels

List lead-capture funnels

get/v1/public/marketing-funnels

Parameters

No parameters.

Responses

200

Examples

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

Accepts Idempotency-Key

Parameters

Idempotency-Keystringoptional· header

Field	In	Type	Description
`Idempotency-Key`optional	header	string

Body (JSON)required

namestringrequired
descriptionstringoptional
stagesobject[]optional
stages[].idstringoptional
stages[].namestringrequired
stages[].ordernumberrequired
stages[].colorstringoptional
stages[].isInitialbooleanoptional
stages[].isGoalbooleanoptional
staleDaysnumberoptional: Auto-lose cards idle for this many days (null/omitted = disabled).
autoCreateDealbooleanoptional: Ganhar um card cria um negócio no funil de vendas.
dealStageIdstringoptional: Estágio do pipeline onde o negócio nasce (null = primeiro da organização).

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

Responses

201

Examples

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

Parameters

cardIdstringrequired· path: Funnel lead/card ID

Field	In	Type	Description
`cardId`required	path	string	Funnel lead/card ID

Responses

200

Examples

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

Accepts Idempotency-Key

Parameters

cardIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`cardId`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

stageIdstringrequired
positionnumberoptional

Field	Type	Description
`stageId`required	string
`position`optional	number

Responses

200

Examples

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}

Accepts Idempotency-Key

Parameters

cardIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`cardId`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

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

Field	Type	Description
`status`optional	string	`ACTIVEWONLOST`
`lostReason`optional	string	Why the card was lost (stored when status becomes LOST).
`estimatedValue`optional	number	Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Responses

200

Examples

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}

Parameters

cardIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`cardId`required	path	string
`Idempotency-Key`optional	header	string

Responses

204

Examples

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}

Accepts Idempotency-Key

Parameters

ruleIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`ruleId`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

namestringoptional
triggerobjectoptional
fromStageIdstringoptional
toStageIdstringoptional
conditionsobject[]optional
conditions[].fieldstringrequired: messageBodychanneltagNameemailTypeidleDays
conditions[].operatorstringrequired: existsequalsnot_equalscontainsgtelte
conditions[].valueobjectoptional
actionsobject[]optional
actions[].typestringrequired: add_tagsend_webhookmark_lostnotify
actions[].paramsobjectoptional
isActivebooleanoptional
ordernumberoptional

Field	Type	Description
`name`optional	string
`trigger`optional	object
`fromStageId`optional	string
`toStageId`optional	string
`conditions`optional	object[]
`conditions[].field`required	string	`messageBodychanneltagNameemailTypeidleDays`
`conditions[].operator`required	string	`existsequalsnot_equalscontainsgtelte`
`conditions[].value`optional	object
`actions`optional	object[]
`actions[].type`required	string	`add_tagsend_webhookmark_lostnotify`
`actions[].params`optional	object
`isActive`optional	boolean
`order`optional	number

Responses

200

Examples

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}

Parameters

ruleIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`ruleId`required	path	string
`Idempotency-Key`optional	header	string

Responses

204

Examples

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

Parameters

stageIdstringrequired· path

Field	In	Type	Description
`stageId`required	path	string

Responses

200

Examples

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

Parameters

stageIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`stageId`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

isActivebooleanoptional
onExhaustobjectrequired
onExhaustStageIdstringoptional
stepsobject[]required
steps[].idstringoptional
steps[].ordernumberrequired
steps[].delayMinutesnumberrequired: Delay from the previous step (or stage entry for the first step), in minutes.
steps[].channelobjectrequired
steps[].subjectstringoptional
steps[].bodystringrequired
steps[].templateIdstringoptional
steps[].isBreakupbooleanoptional

Field	Type	Description
`isActive`optional	boolean
`onExhaust`required	object
`onExhaustStageId`optional	string
`steps`required	object[]
`steps[].id`optional	string
`steps[].order`required	number
`steps[].delayMinutes`required	number	Delay from the previous step (or stage entry for the first step), in minutes.
`steps[].channel`required	object
`steps[].subject`optional	string
`steps[].body`required	string
`steps[].templateId`optional	string
`steps[].isBreakup`optional	boolean

Responses

200

Examples

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

Parameters

stageIdstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`stageId`required	path	string
`Idempotency-Key`optional	header	string

Responses

204

Examples

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

Parameters

idstringrequired· path
limitnumberoptional· query
pagenumberoptional· query
inactiveDaysnumberoptional· query
campaignIdstringoptional· query
minLeadScorenumberoptional· query
statusACTIVE | WON | LOST | STALLEDoptional· query
stageIdstringoptional· query

Field	In	Type
`id`required	path	string
`limit`optional	query	number
`page`optional	query	number
`inactiveDays`optional	query	number
`campaignId`optional	query	string
`minLeadScore`optional	query	number
`status`optional	query	ACTIVE \| WON \| LOST \| STALLED
`stageId`optional	query	string

Responses

200

Examples

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

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

contactIdstringrequired
stageIdstringoptional
campaignIdstringoptional
estimatedValuenumberoptional: Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Field	Type	Description
`contactId`required	string
`stageId`optional	string
`campaignId`optional	string
`estimatedValue`optional	number	Valor estimado do lead; vira o valor inicial do negócio ao ganhar o card.

Responses

201

Examples

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

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

200

Examples

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

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

200

Examples

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

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

namestringrequired
triggerobjectrequired
fromStageIdstringoptional
toStageIdstringrequired
conditionsobject[]optional
conditions[].fieldstringrequired: messageBodychanneltagNameemailTypeidleDays
conditions[].operatorstringrequired: existsequalsnot_equalscontainsgtelte
conditions[].valueobjectoptional
actionsobject[]optional
actions[].typestringrequired: add_tagsend_webhookmark_lostnotify
actions[].paramsobjectoptional
ordernumberoptional

Field	Type	Description
`name`required	string
`trigger`required	object
`fromStageId`optional	string
`toStageId`required	string
`conditions`optional	object[]
`conditions[].field`required	string	`messageBodychanneltagNameemailTypeidleDays`
`conditions[].operator`required	string	`existsequalsnot_equalscontainsgtelte`
`conditions[].value`optional	object
`actions`optional	object[]
`actions[].type`required	string	`add_tagsend_webhookmark_lostnotify`
`actions[].params`optional	object
`order`optional	number

Responses

201

Examples

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}

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

200

Examples

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}

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Body (JSON)required

namestringoptional
descriptionstringoptional
isActivebooleanoptional
staleDaysnumberoptional: Auto-lose cards idle for this many days; null disables the behavior.
autoCreateDealbooleanoptional: Ganhar um card cria um negócio no funil de vendas.
dealStageIdstringoptional: Estágio do pipeline onde o negócio nasce (null = primeiro da organização).
stagesobject[]optional: Full replace of the stage set (creates/updates/removes to match).
stages[].idstringoptional
stages[].namestringrequired
stages[].ordernumberrequired
stages[].colorstringoptional
stages[].isInitialbooleanoptional
stages[].isGoalbooleanoptional

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

Responses

200

Examples

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}

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

204

Examples

bash

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

Full reference