Skip to main content
Version: 6.1.0

SysEnableCampaign

Enables or disables a campaign. Only the enabled flag is changed — all other campaign fields are left untouched. The campaign must not have ended.

The campaign configuration is re-validated before it is enabled, so a campaign that has become invalid (for example, because its target segment was deleted) cannot be enabled until it is fixed.

ServiceOperation
campaignSYS_ENABLE_CAMPAIGN

Method Parameters​

ParameterDescription
campaignCodeThe campaign code to enable or disable.
enabletrue to enable the campaign, false to disable it.

Usage​

http://localhost:3000
// Cloud Code only. To view example, switch to the Cloud Code tab
JSON Response
{
"data": {
"campaignCode": "SUMMER2026",
"enabled": true,
"version": 2,
"updatedAt": 1811725200000
},
"status": 200
}
Common Error Codes

Status Codes​

CodeNameDescription
40345MISSING_RECORDNo campaign exists for the specified campaignCode.
40001INVALID_REQUESTThe campaign has ended and can no longer be modified.
41055INVALID_CAMPAIGN_CONFIGURATIONThe campaign configuration is no longer valid and the campaign cannot be enabled. The error message describes the specific problem.
40616CLOUD_CODE_ONLY_METHODThe method was called from a client. It can only be called from Cloud Code or S2S.
40731FEATURE_NOT_SUPPORTED_BY_BILLING_PLANBilling plan does not include the Campaign feature. Requires a plan that includes Enterprise features.