Update bonus promotion

Update bonus promotionServer-sideAdmin

put/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus

Updates the promotion.

Note

New data will replace old data. If you want to update only a part of a promotion, you should transfer all required data in request as well.

Promotion adds free bonus items to the purchase made by a user. The promotion can be applied to every purchase within a project or to a purchase that includes particular items.

SecuritybasicAuth

Request

path Parameters

project_id required	integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056
promotion_id required	integer Promotion ID. Unique promotion identifier within the project. Example: 111425

Request Body schema: application/json

required

Array of objects or null

Set of items required to be included in the purchase for applying a promotion. If this parameters is null, a promotion will be applied to any purchases within a project.

Array

sku	string Default: "elven_sword" Item SKU.

required

Array of objects or null

Array

sku	string Default: "elven_shield" Item SKU.
quantity	number Default: 1 Item quantity.

required

object

Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.

property name*

additional property

string

integer

Promotion ID. Unique promotion identifier within the project.

Array of objects

Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.

Array

date_from required	string <date-time> Start date for the specified promotion.
date_until	string or null <date-time> End date for the specified promotion. If set to `null`, the promotion is indefinite. Can be `null` only if a single validity period is specified.

Array of type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

Conditions for validating user attributes. Determine promotion availability based on whether user attributes match all specified conditions.

Array ([ 1 .. 100 ] items)

One of:

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

User attribute code.

operator

required

string

Type of operation performed by condition. For string attribute type.

Enum:	Description
eq	Equals
ne	Not equals

value

required

string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type

required

string

User attribute type.

Value: "string"

can_be_missing

boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

object

Promotion limits.

per_user

integer or null

Promotion limitation for a separate user.

object or null

Limit refresh period.

object

User limit refresh period.

interval_type	string Recurrent refresh period type. Enum: "daily" "weekly" "monthly"
day_of_week	integer or null [ 1 .. 7 ] Day of the week when the limits refresh. Where 1 is Monday and 7 is Sunday. Not `null` only for `weekly` limit refresh period type.
day_of_month	integer or null [ 1 .. 31 ] Day of the month when limits refresh. If there's no selected day of the month as it's shorter, then the refresh will occur on the last day of the month. Not `null` only for `monthly` limit refresh period type.
time	string <full-time> Time of limit refresh in the desired time zone (rounding to hours).
reset_next_date	integer Date and time when limits refresh (Unix Timestamp).
displayable_reset_start_date	string <date-time> Date and time of the first limit refresh (ISO 8601).
displayable_reset_next_date	string <date-time> Date and time when limits should reset (ISO 8601).

Array of objects or null

Array of objects with conditions that set the price range for applying the promotion.
The promotion applies only to items whose price meets all the conditions in the array. If you pass this array, set the value of the condition object to null.

Array

operator

required

string

Comparison operator for setting the price range for applying the promotion.

Enum:	Description
ge	Greater or equal
gt	Greater than
le	Less or equal
lt	Less than
eq	Equals
ne	Not equals

value

required

string^\d+(\.\d{1,4})?$

Value for determining the price range for applying the promotion.

excluded_promotions

Array of integers

List of promotion IDs to exclude when applying this promotion.
Example: [12, 789]

is_enabled

boolean

Whether promotion is enabled or not.

Responses

204

Promotion was successfully updated.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

422

Invalid request.

Request samples

application/json

{"promotion_periods": [{"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"name": {"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"condition": [{"sku": "com.xsolla.elven_boots_1"
},
{"sku": "com.xsolla.elven_knife_1"
}
],
"bonus": [{"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
]
}

Response samples

application/json

{"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}