Move Affiliate To Campaign

POST 
/affiliate-manager/affiliate-campaign/:locationId/affiliate/:affiliateId/move-campaign

Move an affiliate from one campaign to another. The target campaign must be live and belong to the same location, and the affiliate must not already be enrolled in it.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

application/json

application/json

Body

Bodyrequired

sourceCampaignIdstringrequired

Source Campaign Id

targetCampaignIdstringrequired

Target Campaign Id

moveModenumberrequired
Move mode — 1 keeps recurrent commissions in the old campaign, 2 moves all data with the original AM id
Available options12
sendWelcomeEmailboolean
Whether to send a welcome email to this affiliate after moving. If the target campaign has welcome emails disabled, no email will be sent even if this is turned on. If the campaign has it enabled, you can disable it here to skip sending for this affiliate.
Default value: true

Example (auto)

{
  "sourceCampaignId": "6385d230f6d19db03eef6fb2",
  "targetCampaignId": "6512c3a1f6d19db03eef7a04",
  "moveMode": 1,
  "sendWelcomeEmail": true
}

application/json

Successful response

application/json

Schema

Schema

successbooleanrequired

Whether the action completed

messagestringrequired

Human readable outcome

Example (auto)

{
  "success": true,
  "message": "Affiliate suspended successfully"
}