Create offer chain

To Publisher Account

Create offer chainServer-sideAdmin

post/v2/project/{project_id}/admin/offer_chain

Creates an offer chain.

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

Request Body schema: application/json

required

(two-letter (object or null)) or (five-letter (object or null))

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en	string or null English
ar	string or null Arabic
bg	string or null Bulgarian
cn	string or null Chinese (Simplified)
cs	string or null Czech
de	string or null German
es	string or null Spanish (Spain)
fr	string or null French
he	string or null Hebrew
it	string or null Italian
ja	string or null Japanese
ko	string or null Korean
pl	string or null Polish
pt	string or null Portuguese
ro	string or null Romanian
ru	string or null Russian
th	string or null Thai
tr	string or null Turkish
tw	string or null Chinese (Traditional)
vi	string or null Vietnamese
km	string or null Khmer
id	string or null Indonesian
lo	string or null Lao
my	string or null Burmese
ph	string or null Filipino
ne	string or null Nepali

date_start

required

string <date-time>

Date when the offer chain starts.

required

Array of objects

Array

step_number

required

integer >= 1

Step number.

is_free

required

boolean

Indicates whether the offer chain step is free:

If true, the step must be claimed using the Claim free offer chain step call.
If false, it must be purchased using the Create order for paid offer chain step call.

required

Array of objects non-empty

Array (non-empty)

sku required	string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$ Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
quantity required	integer >= 1 Reward item quantity for this chain step.
order	integer or null >= 0 Reward order for the offer chain step.

is_enabled

required

boolean

order

integer

Defines arrangement order.

(two-letter (object or null)) or (five-letter (object or null))

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en	string or null English
ar	string or null Arabic
bg	string or null Bulgarian
cn	string or null Chinese (Simplified)
cs	string or null Czech
de	string or null German
es	string or null Spanish (Spain)
fr	string or null French
he	string or null Hebrew
it	string or null Italian
ja	string or null Japanese
ko	string or null Korean
pl	string or null Polish
pt	string or null Portuguese
ro	string or null Romanian
ru	string or null Russian
th	string or null Thai
tr	string or null Turkish
tw	string or null Chinese (Traditional)
vi	string or null Vietnamese
km	string or null Khmer
id	string or null Indonesian
lo	string or null Lao
my	string or null Burmese
ph	string or null Filipino
ne	string or null Nepali

date_end

string or null <date-time>

Date when the offer chain ends. Can be null. If date_end is null, the offer chain will not have a time limit.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = hourly (object or null))

Reset period of the offer chain.

One of:

Weekly reset of the offer chain.

interval_type required	string Frequency of the offer chain reset. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... The time when the offer chain is reset in the specified time zone (rounding to hours). For example, the reset time is set to 01:00 for the Kuala Lumpur time zone (GMT+8), the value of the `time` parameter is `01:00:00+08:00`.
day_of_week required	integer [ 1 .. 7 ] Day of the week when the offer chain is reset, where `1` is Monday and `7` is Sunday.

is_always_visible

boolean

Default: true

Whether the chain is visible to all users:

If true, the chain is always displayed, regardless of the user's authentication status or attributes.
If false, the chain is displayed only if no personalized chain is found. For example, if the user is not authenticated or their attributes don’t match any personalized chain.

Applies only in the context of personalized chains and is used if the attribute_conditions array is not passed.

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

Conditions for validating user attributes. Determine chain 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.

Responses

201

The offer chain was successfully created.

401

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

422

Invalid offer chain configuration.

Request samples

application/json

{"name": {"en": "New offer chain",
"ru": "Новая цепочка предложений",
"de": "Neue Angebotskette",
"fr": "Nouvelle chaîne d'offres",
"it": "Nuova catena di offerte"
},
"description": {"en": "A short description of a regular offer chain",
"ru": "Краткое описание обычной цепочки предложений",
"de": "Eine kurze Beschreibung einer regulären Angebotskette",
"fr": "Une brève description d'une chaîne d'offres régulière",
"it": "Una breve descrizione di una catena di offerte regolare"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": null,
"recurrent_schedule": null,
"is_enabled": true,
"steps": [{"step_number": 1,
"is_free": false,
"items": [{"sku": "chain_step_1_paid_bundle_sku",
"quantity": 2
}
]
},
{"step_number": 2,
"is_free": true,
"items": [{"sku": "chain_step_2_free_virtual_good_sku",
"quantity": 1
}
]
},
{"step_number": 3,
"is_free": false,
"items": [{"sku": "chain_step_3_paid_virtual_currency_package_sku",
"quantity": 5
}
]
},
{"step_number": 4,
"is_free": true,
"items": [{"sku": "chain_step_4_free_bundle_sku",
"quantity": 1
}
]
}
],
"is_always_visible": true
}

Response samples

application/json

{"offer_chain_id": 10
}