- 13 Mar 2025
- DarkLight
Create Offers
- Updated on 13 Mar 2025
- DarkLight
Our Create Offers API allows Advertisers to upload offers directly to the MyOffers system, via the endpoint below. Here, you can upload both promotions and vouchers. However, there will be no voucher attribution or publisher exclusivity in the functional scope of this API. Therefore, vouchers can be uploaded without publisher attribution or exclusivity (this must still be done via the UI).
However, the main benefit of this API is that you can add multiple offers via API, thus allowing you to upload in batches. Below we will give an example of the request for a single upload and batch. They must be written in JSON format to be valid. The values for regions and categories are numeric; see here for the full list and mapping of each. If you would like to apply your offer to all regions, add “true” to “appliesToAllRegions”.
Please note
The “multiple” mentioned can be achieved by making multiple API calls. You can still only upload 1 offer per request. We will give examples of scripts to upload batches. This does mean that the limit is 50 offers per minute (due to the 50 calls/per minute limitation)r content goes here
Endpoint
Endpoint (POST): https://api.awin.com/promotion/advertiser/{advertiser_id}
{advertiser_id} is the ID of your advertiser account.
Body Parameters
Parameter | Required | Type | Description |
---|---|---|---|
title | Yes | String | Give your offer a title (e.g. Black Friday 2025). Must be between 1 and 300 characters. |
description | Yes | String | Add a description (e.g. Save 30% on all products this Black Friday). Must be between 1 and 500 characters. |
terms | Yes | String | Any terms that may apply (e.g. offer valid until the end of the month). Required for Vouchercode type Offers. Must be between 1 and 10000 characters. |
type | Yes | String | Use either ‘promotion’ or ‘voucher’ |
voucherCode | Only for type ‘voucher’ | String | The vouchercode (e.g. OFF30). This field is required for offer type Voucher. |
url | Yes | String | Provide a specific landing page URL for your publishers to link to. Link must start with either http:// or https:// |
startDate | Yes | String | When your offer starts (format: YYYY-MM-DD) |
endDate | Yes | String | When your offer ends (format: YYYY-MM-DD) |
appliestoAllRegions | Yes | Boolean | Set true if your offer is applicable to customers from all regions. |
regions | Only if appliestoAllRegions is false | Number (Array) | For mapping see below |
promotionCategories | Yes | Number (Array) | For mapping see below |
Mapping
Region Mapping
Here we will map out and describe each region and its corresponding number, so you can offers in specific promotional categories:
Region | Corresponding number |
United Kingdom | 1 |
Ireland | 2 |
United States of America | 3 |
Canada | 4 |
France | 5 |
Germany | 6 |
Austria | 7 |
Belgium | 8 |
Netherlands | 9 |
Spain | 10 |
Italy | 11 |
Finland | 13 |
Poland | 15 |
Switzerland | 16 |
Sweden | 17 |
Norway | 18 |
Denmark | 19 |
Australia | 20 |
Brazil | 21 |
Portugal | 22 |
Russia | 23 |
Czech Republic | 24 |
Hungary | 25 |
Romania | 26 |
Slovakia | 27 |
Slovenia | 28 |
Ukraine | 29 |
Bulgaria | 30 |
Croatia | 31 |
Greece | 32 |
Latvia | 33 |
Lithuania | 34 |
New Zealand | 35 |
South Africa | 36 |
United Arab Emirates | 37 |
China | 38 |
India | 39 |
Japan | 40 |
Singapore | 41 |
Argentina | 42 |
Chile | 43 |
Colombia | 44 |
Mexico | 45 |
Peru | 46 |
Turkey | 47 |
Brazil USD | 48 |
Category Mapping
Here we will map out and describe each region and its corresponding number, so you can offers in specific promotional categories:
Category | Corresponding numbers |
Credit Cards | 5 |
Insurance | 6 |
Savings & Investments | 7 |
Loans | 8 |
Mortgages | 9 |
Personal Banking | 10 |
Property | 11 |
Audio Visual | 12 |
Automotive | 13 |
Books & Subscriptions | 14 |
Childrenswear | 15 |
Clothing | 16 |
Clothing Accessories | 17 |
Computers | 18 |
Department Stores | 19 |
DIY | 20 |
Electronic Accessories | 21 |
Electronic Superstore | 22 |
Entertainment Superstore | 23 |
Erotic | 24 |
FMCG | 25 |
Furniture & Soft Furnishings | 26 |
Gadgets | 27 |
Gifts & Flowers | 28 |
Green (Eco friendly) | 29 |
Group Buying | 30 |
Health & Beauty | 31 |
Home & Garden | 32 |
Jewellery | 33 |
Lead Gen | 34 |
Lingerie | 35 |
Menswear | 36 |
Music & DVD | 37 |
Office Supplies | 38 |
PC & Video Games | 39 |
Pets & Pet Care | 40 |
Pharmaceuticals | 41 |
Photography | 42 |
Photos & Print Services | 43 |
Shoes | 44 |
Sports Equipment | 45 |
Sportswear | 46 |
Toys & Games | 47 |
White Goods | 48 |
Wine, Spirits & Tobacco | 49 |
Womenswear | 50 |
B2B Telecommunications Services | 51 |
B2B Utility Services | 52 |
Business Services (B2B) | 53 |
Cable & Satellite Operators | 54 |
Charities | 55 |
Dating | 56 |
Digital TV & Video-on-Demand | 57 |
Education, Training & Recruitment | 58 |
Entertainment Downloads | 59 |
Gambling & Competitions | 60 |
Internet Service Provider | 61 |
Lead Gen | 62 |
Mobile Broadband | 63 |
Mobile Downloads | 64 |
Mobile Pay As You Go | 65 |
Network Operators | 66 |
Online Gaming | 67 |
Software Downloads | 68 |
Tickets | 69 |
Utilities | 70 |
Web Hosting | 71 |
Airlines | 72 |
Airport Parking & Transfers | 73 |
Car Rental | 74 |
Coaches | 75 |
Cruises & Ferries | 76 |
Hotels & Accommodation | 77 |
Lead Gen | 78 |
Local Holidays | 79 |
Tourism & Attractions | 80 |
Trains | 81 |
Travel Agencies | 82 |
Mobile Contract | 83 |
Baby & Toddler | 84 |
Example Request Body
{
"title": "Black Friday 30% Off",
"description": "Save 30% on all products this Black Friday.",
"terms": "Offer valid until the end of the month.",
"type": "voucher",
"voucherCode": "30OFF", //this field is only required for the Offer type 'voucher'
"url": "https://www.example.com",
"startDate": "2023-10-15",
"endDate": "2023-11-15",
"appliesToAllRegions": false,
"regions": [
29
],
"promotionCategories": [
12,
16
]
}
Response
Code | Description |
---|---|
200 | Offer was created successfully |
400 | Invalid input |
404 | The specified resource was not found, Media type |