TAtalon
Campaigns

Copy the campaign into the specified Application

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Copy the campaign into all specified Applications.

post/v1/applications/{applicationId}/campaigns/{campaignId}/copy

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

Request body

namestring

Name of the copied campaign (Defaults to "Copy of original campaign name").

applicationIdsinteger[] required

Application IDs of the applications to which a campaign should be copied to.

descriptionstring

A detailed description of the campaign.

startTimestring date-time

Timestamp when the campaign will become active.

endTimestring date-time

Timestamp when the campaign will become inactive.

tagsstring[]

A list of tags for the campaign.

evaluationGroupIdinteger

The ID of the campaign evaluation group the campaign belongs to.

Example request

{
  "name": "Copy of Summer promotions",
  "applicationIds": [
    1,
    2,
    3
  ],
  "description": "Campaign for all summer 2021 promotions",
  "startTime": "2021-06-01T09:00:27.993483Z",
  "endTime": "2021-09-10T01:00:00.993483Z",
  "tags": [
    "Summer",
    "Shoes"
  ],
  "evaluationGroupId": 2
}

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 4,
      "created": "2020-06-10T09:05:27.993483Z",
      "applicationId": 322,
      "userId": 388,
      "name": "Summer promotions",
      "description": "Campaign for all summer 2021 promotions",
      "startTime": "2021-07-20T22:00:00Z",
      "endTime": "2021-09-22T22:00:00Z",
      "state": "enabled",
      "activeRulesetId": 6,
      "tags": [
        "summer"
      ],
      "reevaluateOnReturn": true,
      "features": [
        "coupons",
        "referrals"
      ],
      "couponSettings": {
        "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"
        ],
        "couponPattern": "SUMMER-####-####"
      },
      "referralSettings": {
        "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"
        ],
        "couponPattern": "SUMMER-####-####"
      },
      "limits": [
        {
          "action": "createCoupon",
          "limit": 1000,
          "period": "yearly",
          "entities": [
            "Coupon"
          ]
        }
      ],
      "campaignGroups": [
        1,
        3
      ],
      "type": "advanced",
      "linkedStoreIds": [
        1,
        2,
        3
      ],
      "budgets": [
        {
          "action": "createCoupon",
          "limit": 1000,
          "counter": 42
        }
      ],
      "couponRedemptionCount": 163,
      "referralRedemptionCount": 3,
      "discountCount": 288,
      "discountEffectCount": 343,
      "couponCreationCount": 16,
      "referralCreationCount": 8,
      "awardedGiveawaysCount": 9,
      "createdLoyaltyPointsCount": 9,
      "createdLoyaltyPointsEffectCount": 2,
      "redeemedLoyaltyPointsCount": 8,
      "redeemedLoyaltyPointsEffectCount": 9,
      "reservecouponEffectCount": 9,
      "lastActivity": "2022-11-10T23:00:00Z",
      "updated": "2022-10-27T15:00:00Z",
      "createdBy": "John Doe",
      "updatedBy": "Jane Doe",
      "templateId": 3,
      "frontendState": "running",
      "storesImported": true,
      "valueMapsIds": [
        100,
        215
      ],
      "experimentId": 1,
      "revisionFrontendState": "revised",
      "activeRevisionId": 6,
      "activeRevisionVersionId": 6,
      "version": 6,
      "currentRevisionId": 6,
      "currentRevisionVersionId": 6
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.