Skip to main content
POST
Create a cancel-reward action

Authorizations

Authorization
string
header
required

Path Parameters

campaignId
string
required
version
string
required
Pattern: (/version/.+)?
controllerId
string
required

Body

application/json

Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/cancel-rewards request.

component_ids
string[]
component_references
object[]
enabled

Choose between static or dynamic enabled

message
string | null
quality
enum<string>
Available options:
ALWAYS,
HIGH,
LOW
reward_id
string

Response

Successful response

action_id
string
action_type
enum<string>
Available options:
CANCEL_REWARD
component_ids
string[]
component_references
object[]
enabled

The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.

quality
enum<string>
Available options:
ALWAYS,
HIGH,
LOW
message
string
reward_id
string