SysRemoveAllCampaignsForUser

Removes a player's participation in all campaigns, deleting all their CampaignParticipant records and clearing the campaigns map from their profile.

Service	Operation
campaign	SYS_REMOVE_ALL_CAMPAIGNS_FOR_USER

Method Parameters

Parameter	Description
profileId	The profile ID of the player to remove all campaigns for.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

// N/A

GDScript

N/A

Cloud Code

var profileId = "aProfileId";
var campaignProxy = bridge.getCampaignServiceProxy();

var postResult = campaignProxy.sysRemoveAllCampaignsForUser(profileId);

Raw

{
    "service": "campaign",
    "operation": "SYS_REMOVE_ALL_CAMPAIGNS_FOR_USER",
    "data": {
        "profileId": "aProfileId"
    }
}

JSON Response

{
    "data": {},
    "status": 200
}

Common Error Code

Status Codes

Code	Name	Description
40206	BILLING_PLAN_INCLUDES_CAMPAIGN	Billing plan does not include the Campaign feature.