Menu
Create Campaign From Template
Create campaign from campaign template
POST
/v1/applications/{applicationId}/create_campaign_from_templateUse it in a workflow
- Add a step and choose the Talon.One connector.
- Pick the Create Campaign From Template action (under management).
- Fill in the fields below, then reference the result from later steps as
{{createCampaignFromTemplate.response.data}}.
Request
Path parameters
Request body
Enter the body as JSON in the step's Body field.
{
"name": "Discount campaign",
"templateId": 4,
"description": "This template is for discount campaigns.",
"campaignAttributesOverrides": {},
"templateParamValues": [
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
}
],
"limitOverrides": [
{
"period": "yearly",
"entities": [
"Coupon"
],
"limit": 1000,
"action": "createCoupon"
}
],
"campaignGroups": [
1,
3
],
"tags": [
"summer"
],
"evaluationGroupId": 2,
"linkedStoreIds": [
1,
2,
3
]
}
Response
Returns 201 with an object. Read it in later steps with {{createCampaignFromTemplate.response.data.<field>}}.
{
"campaign": {
"type": "advanced",
"templateId": 3,
"customEffectCount": 0,
"activeRevisionId": 6,
"features": [
"coupons",
"referrals"
],
"createdLoyaltyPointsCount": 9,
"storesImported": true,
"couponSettings": {
"couponPattern": "SUMMER-####-####",
"validCharacters": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
]
},
"experimentId": 1,
"id": 4,
"state": "enabled",
"couponAttributes": "{}",
"reservecouponEffectCount": 9,
"updatedBy": "Jane Doe",
"frontendState": "running",
"created": {},
"referralCreationCount": 8,
"stageRevision": false,
"couponRedemptionCount": 163,
"couponCreationCount": 16,
"version": 6,
"campaignGroups": [
1,
3
],
"tags": [
"summer"
],
"discountEffectCount": 343,
"budgets": [
{
"limit": 1000,
"action": "createCoupon",
"counter": 42
},
{
"limit": 1000,
"action": "createCoupon",
"counter": 42
}
],
"redeemedLoyaltyPointsCount": 8,
"name": "Summer promotions",
"valueMapsIds": [
100,
215
],
"applicationId": 322,
"updated": {},
"callApiEffectCount": 0,
"createdLoyaltyPointsEffectCount": 2,
"discountCount": 288,
"revisionFrontendState": "revised",
"description": "Campaign for all summer 2021 promotions",
"activeRevisionVersionId": 6,
"currentRevisionVersionId": 6,
"startTime": {},
"currentRevisionId": 6,
"limits": [
{
"period": "yearly",
"entities": [
"Coupon"
],
"limit": 1000,
"action": "createCoupon"
},
{
"period": "yearly",
"entities": [
"Coupon"
],
"limit": 1000,
"action": "createCoupon"
}
],
"activeRulesetId": 6,
"reevaluateOnReturn": true,
"userId": 388,
"awardedGiveawaysCount": 9,
"redeemedLoyaltyPointsEffectCount": 9,
"linkedStoreIds": [
1,
2,
3
],
"createdBy": "John Doe",
"addFreeItemEffectCount": 0,
"referralSettings": {
"couponPattern": "SUMMER-####-####",
"validCharacters": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
]
},
"attributes": "{}",
"lastActivity": {},
"endTime": {},
"referralRedemptionCount": 3
},
"ruleset": {
"rbVersion": "v2",
"created": {},
"campaignId": 320,
"bindings": [],
"activatedAt": {},
"activate": true,
"rules": [
{
"condition": [
"and",
[
"couponValid"
]
],
"effects": [
"catch",
[
"noop"
],
[
"setDiscount",
"10% off",
[
"*",
[
".",
"Session",
"Total"
],
[
"/",
10,
100
]
]
]
],
"bindings": [
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
},
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
}
],
"description": "Creates a discount when a coupon is valid",
"id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"title": "Give discount via coupon",
"parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
},
{
"condition": [
"and",
[
"couponValid"
]
],
"effects": [
"catch",
[
"noop"
],
[
"setDiscount",
"10% off",
[
"*",
[
".",
"Session",
"Total"
],
[
"/",
10,
100
]
]
]
],
"bindings": [
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
},
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
}
],
"description": "Creates a discount when a coupon is valid",
"id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"title": "Give discount via coupon",
"parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
}
],
"id": 6,
"strikethroughRules": [
{
"condition": [
"and",
[
"couponValid"
]
],
"effects": [
"catch",
[
"noop"
],
[
"setDiscount",
"10% off",
[
"*",
[
".",
"Session",
"Total"
],
[
"/",
10,
100
]
]
]
],
"bindings": [
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
},
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
}
],
"description": "Creates a discount when a coupon is valid",
"id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"title": "Give discount via coupon",
"parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
},
{
"condition": [
"and",
[
"couponValid"
]
],
"effects": [
"catch",
[
"noop"
],
[
"setDiscount",
"10% off",
[
"*",
[
".",
"Session",
"Total"
],
[
"/",
10,
100
]
]
]
],
"bindings": [
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
},
{
"attributeId": 100,
"minValue": 0,
"expression": [
"string1",
"string2"
],
"maxValue": 19.9,
"valueType": "string",
"name": "my property",
"description": "This is a template parameter of type `number`.",
"type": "templateParameter"
}
],
"description": "Creates a discount when a coupon is valid",
"id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"title": "Give discount via coupon",
"parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
}
],
"templateId": 3,
"userId": 388
},
"collections": [
{
"accountId": 3886,
"createdBy": 134,
"payload": [
"KTL-WH-ET-1",
"KTL-BL-ET-1"
],
"created": {},
"campaignId": 7,
"subscribedApplicationsIds": [
1,
2,
3
],
"name": "My collection",
"modified": {},
"description": "My collection of SKUs",
"modifiedBy": 48,
"id": 6,
"applicationId": 1
}
]
}
Need more? See the Talon.One guide for connection setup and behaviour shared by every action.
Was this page helpful?