Update Affiliate Suspension

Suspend or reinstate an affiliate on a campaign. Suspending cancels their pending and denied payouts, commissions and transactions; reinstating returns cancelled ones to pending.

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

campaignIdstringrequired

Campaign Id

Example:6385d230f6d19db03eef6fb2

affiliateIdstringrequired

Affiliate Id

Example:63d376de11be1d26d38f7369

Body

application/json

isSuspendedbooleanrequired

Whether the affiliate is suspended on this campaign. Suspending cancels their pending and denied payouts, commissions and transactions; unsuspending returns cancelled ones to pending.

Example:true

Response

200

application/json

Successful response

successbooleanrequired

Whether the action completed

Example:true

messagestringrequired

Human readable outcome

Example:Affiliate suspended successfully