Generate Campaign Link

post

https://{APP_DOMAIN}/api/3.2/marketing/campaigns/{id}/generate-link

Generates a trackable campaign link by creating an effort chain. Optionally creates an Everflow offer URL and tracking link for affiliate tracking. Pass locales to generate one chain per language, each pointing at that language's translated pages; the response's effort_id and link remain the default locale's, with every generated link listed under links.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the campaign

Body Params

name

string

required

Name for the effort

effort_type_id

integer

required

The effort type ID

partner_id

integer

required

The partner ID

lift_id

integer

Lift letter resource ID

advertorial_id

integer

Advertorial landing page ID

promo_id

integer

Promo landing page ID

order_page_id

integer

Order page landing page ID

external_url

string

External URL for the offer

exit_intent_promo_id

integer

Exit intent promo landing page ID

exit_intent_order_page_id

integer

Exit intent order page ID

use_everflow_offer

boolean

Whether to create an Everflow offer URL

everflow_offer_id

integer

Everflow offer ID for affiliate tracking

locales

array of strings

Locales to generate a chain in. Defaults to the instance default locale. Each must be fully translated across the chain — see GET /marketing/campaigns/{id}/languages.

locales

Responses

200

The generated campaign link with effort ID, plus a links array with one entry per locale

422

Invalid request (e.g. missing effort type, partner, Everflow configuration, or a locale the chain is not fully translated into).