AffiliatesVersion: v3

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

affiliateIdstringrequired

Affiliate Id

Example:6385d230f6d19db03eef6fb2

Body

application/json

sourceCampaignIdstringrequired

Source Campaign Id

Example:6385d230f6d19db03eef6fb2

targetCampaignIdstringrequired

Target Campaign Id

Example:6512c3a1f6d19db03eef7a04

moveModenumberrequired

Move mode — 1 keeps recurrent commissions in the old campaign, 2 moves all data with the original AM id

Available options12

Example:1

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:true

Example:true

Response

application/json

Successful response

successbooleanrequired

Whether the action completed

Example:true

messagestringrequired

Human readable outcome

Example:Affiliate suspended successfully