The Easypromos API allows you to perform some of the operations that you do with our web client.
\nThe API is built using REST principles which ensures predictable URLs that make writing applications easy. The API follows HTTP rules, enable a wide range of HTTP clients can be used to interact with the API.
\n(*) API REST is only available with White Label and Corporate plans.
\nAll Easypromos API calls need to be authenticated using an auth token. You can obtain an auth token from your Easypromos account, in the \"Utilities\" menu. How to obtain an authtoken.
\nThe auth token must be included as a GET parameter for every endpoint call.
\nThe name of the parameter for the authtoken is: access_token
\nExample: https://wl.easypromosapp.com/api/promotions/?access_token={your_authtoken}
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8881525","collectionId":"379598cf-d40b-42a5-bbea-5cbc3a94343f","publishedId":"SWE3cz4F","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-19T08:59:08.000Z"},"item":[{"name":"Promotions - List","event":[{"listen":"test","script":{"id":"5d602a94-e266-43a4-8413-868ad13da398","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 3s\", function () {"," pm.expect(pm.response.responseTime).to.be.below(3000);","});",""],"type":"text/javascript"}}],"id":"6e1bc1ac-ae64-47ef-a9de-ef5f9bbeb089","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://wl.easypromosapp.com/api/promotions/?status=all&p=1","description":"Get the list of all the White Label promotions in one account. Each promotion includes all its information.
\nThe default pagination is 100 promotions per page.
\nFormat: JSON
\n","urlObject":{"protocol":"https","path":[""],"host":["wl.easypromosapp.com/api/promotions"],"query":[{"description":{"content":"The state of the promotions.\nDefault value: all\nAllowed values: \"all\", \"draft\", \"active\", \"expired\"
\n","type":"text/plain"},"key":"status","value":"all"},{"description":{"content":"Number of page to pull. Starts at 1 and if empty is the default\nDefault value: 1
\n","type":"text/plain"},"key":"p","value":"1"}],"variable":[]}},"response":[],"_postman_id":"6e1bc1ac-ae64-47ef-a9de-ef5f9bbeb089"},{"name":"Promotions - Single","event":[{"listen":"test","script":{"id":"757615f7-7af4-4029-b36a-a983b7221506","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 300ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});"],"type":"text/javascript"}}],"id":"ea4a94e8-c630-410a-b01e-9c639b64c5d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://wl.easypromosapp.com/api/promotions/:promotion_id","description":"Get the information of only one White Label promotion.
\nFormat: JSON
\n","urlObject":{"protocol":"https","path":[":promotion_id"],"host":["wl.easypromosapp.com/api/promotions"],"query":[],"variable":[{"description":{"content":"Id promotion
\n","type":"text/plain"},"type":"string","value":"{{promotion_id}}","key":"promotion_id"}]}},"response":[],"_postman_id":"ea4a94e8-c630-410a-b01e-9c639b64c5d9"},{"name":"Promotions - Users","event":[{"listen":"test","script":{"id":"c42fa4ef-1e08-4038-a3b4-8d8ea0d188d1","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 1000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});"],"type":"text/javascript"}}],"id":"9903c47a-b029-4971-a24d-ccbc1135066a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://wl.easypromosapp.com/api/promotions/:promotion_id/users?status=accepted&p=1","description":"Get the list of all all unique users registered in the promotion in a White Label promotion. In promotions with activated autologin\nand multi-participation, only the user's registration data will be returned.
\nThe default pagination is 100 users (items) per page.
\nFormat: JSON
\n[Optional ]The status of the users retrieved
\nDefault value: all
\nAllowed values: \"all\", \"accepted\", \"rejected\", \"pending\"
\n","type":"text/plain"},"key":"status","value":"accepted"},{"description":{"content":"Number of page to pull. Starts at 1 and if empty is the default
\nDefault value: 1
\n","type":"text/plain"},"key":"p","value":"1"}],"variable":[{"description":{"content":"[Required] ID of the promotion
\n","type":"text/plain"},"type":"string","value":"{{promotion_id}}","key":"promotion_id"}]}},"response":[],"_postman_id":"9903c47a-b029-4971-a24d-ccbc1135066a"},{"name":"Promotions - Participations","event":[{"listen":"test","script":{"id":"a0630a86-260f-4abd-b600-bbaa23ec28ca","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 1000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});"],"type":"text/javascript"}}],"id":"e9d68d53-6b85-4946-b630-a7b262ffd495","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://wl.easypromosapp.com/api/promotions/:promotion_id/participations?p=1","description":"Get the list of participations of all users. For example, in a puzzle-type promotion with multiple daily entries, a list\nwith all participations ordered in chronological order will be returned.
\nThe default pagination is 100 users (items) per page.
\nFormat: JSON
\nNumber of page to pull. Starts at 1 and if empty is the default
\nDefault value: 1
\n","type":"text/plain"},"key":"p","value":"1"}],"variable":[{"id":"5265ec01-7349-4938-a550-229a56b22658","description":{"content":"[Required] ID of the promotion
\n","type":"text/plain"},"type":"string","value":"{{promotion_id}}","key":"promotion_id"}]}},"response":[],"_postman_id":"e9d68d53-6b85-4946-b630-a7b262ffd495"},{"name":"Promotions - Leaderboard","event":[{"listen":"test","script":{"id":"9bd4268a-f1c2-4cd5-b39c-e8df34b79830","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 1000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});"],"type":"text/javascript"}}],"id":"af7765a4-de74-403e-82d2-d87957e94b23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://wl.easypromosapp.com/api/promotions/:promotion_id/leaderboard","description":"Get the ranking of the first 100 users in a game-type promotion. This call returns the list of unique users ordered by\nthe best score. Only one hundred users are returned. Basic information is included along with their score.
\nFormat: JSON
\n[Required] ID of the promotion
\n","type":"text/plain"},"type":"string","value":"{{promotion_login_id}}","key":"promotion_id"}]}},"response":[],"_postman_id":"af7765a4-de74-403e-82d2-d87957e94b23"},{"name":"Promotions - Single User","event":[{"listen":"test","script":{"id":"c42fa4ef-1e08-4038-a3b4-8d8ea0d188d1","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 1000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});"],"type":"text/javascript"}}],"id":"ba56ff0e-6fef-4232-803c-9e20e0f581e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://wl.easypromosapp.com/api/promotions/:promotion_id/users/:user_id","description":"Get the information of only one user in a White Label promotion.\nAll users in Easypromos are identified with a Unique ID. This parameter is required when using this call.
\nFormat: JSON
\n","urlObject":{"protocol":"https","path":[":promotion_id","users",":user_id"],"host":["wl.easypromosapp.com/api/promotions"],"query":[],"variable":[{"description":{"content":"[Required] ID of the promotion
\n","type":"text/plain"},"type":"string","value":"{{promotion_id}}","key":"promotion_id"},{"description":{"content":"[Required] Unique User ID in Easypromos
\n","type":"text/plain"},"type":"string","value":"{{user_id}}","key":"user_id"}]}},"response":[{"id":"f27b3d23-2183-43a3-9cde-3bfd96764868","name":"Promotions - Single User","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://wl.easypromosapp.com/api/promotions/:promotion_id/users/:user_id","protocol":"https","host":["wl.easypromosapp.com/api/promotions"],"path":[":promotion_id","users",":user_id"],"variable":[{"description":"[Required] ID of the promotion","key":"promotion_id","value":"{{promotion_id}}"},{"key":"user_id","value":"{{user_id}}","description":"[Required] Unique User ID in Easypromos"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Jan 2020 09:30:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"User\": {\n \"id\": \"636630034\",\n \"promotion_id\": \"33566\",\n \"name\": \"John Smith\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"fbuid\": \"NULL\",\n \"created\": \"2020-01-22 10:28:01\",\n \"public_entry\": \"1\",\n \"country_id\": \"ES\",\n \"keyword\": \"eng\",\n \"ep1\": \"widget\",\n \"ep2\": \"popup\",\n \"ep3\": \"a.cstmapp.com\",\n \"ip\": \"88.26.YYY.XXX\",\n \"email\": \"john.smith@example.com\",\n \"validated\": \"0\",\n \"recruits\": \"0\",\n \"likes\": \"0\",\n \"hashtag_type\": \"0\",\n \"referral_uid\": null,\n \"device\": \"\",\n \"extra\": null,\n \"language\": \"eng\",\n \"referral_url\": \"https://www.easypromosapp.com/spin-the-wheel/\",\n \"date\": \"Jan.22.2020 10:28\",\n \"terms_and_conditions\": \"https://a.cstmapp.com/promo_terms/33566\"\n },\n \"Prize\": [\n {\n \"id\": \"221880\",\n \"prize_type\": \"4865\",\n \"user_id\": \"636630034\",\n \"participation_id\": null,\n \"finalist_id\": null,\n \"promotion_id\": \"33566\",\n \"account_id\": null,\n \"code_id\": null,\n \"qr_code\": \"917\",\n \"status\": \"0\",\n \"pos\": \"3\",\n \"alternate\": \"0\",\n \"replace_id\": null,\n \"reason\": null,\n \"replace_date\": null,\n \"created\": \"2020-01-22 10:28:01\",\n \"created_format\": \"22 Jan 2020, 10:28 h\",\n \"hash\": \"dd26fa8a2105024dbbeace13f7c4d7a6\"\n }\n ]\n}"}],"_postman_id":"ba56ff0e-6fef-4232-803c-9e20e0f581e8"},{"name":"Auto login","event":[{"listen":"test","script":{"id":"df713532-a591-4b7e-a5f8-2d59a0284d09","exec":["// Response is OK","pm.test(\"Response must be valid and have a body\", function () {"," // assert that the status code is 200"," pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants"," // assert that the response has a valid JSON body"," pm.response.to.be.withBody;"," pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed","});","","pm.test(\"Content-Type header is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Response time is less than 1s\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1000);","});"],"type":"text/javascript"}}],"id":"0363be02-f395-4161-819f-329b40f6ccc4","protocolProfileBehavior":{"disableBodyPruning":true,"disableCookies":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"(Mandatory) The External ID is the unique identifier for a user. The value can be a string or number. Easypromos always treats it as a string and converts any number value to a string.\nA External ID should be static. If possible, it should be the same value you use to identify the user in your own system.
\n","equals":true,"key":"external_id","value":"{{external_id}}"},{"description":"(Optional) User's first name.
\n","equals":true,"key":"fname","value":"{{fname}}"},{"description":"(Optional) User's last name.
\n","equals":true,"key":"lname","value":"{{lname}}"},{"key":"nickname","value":"{{nickname}}","description":"(Optional) User's nickname. Recommended if you don't want to pass the real first name and last name. It must be unique among all participants.
\n","type":"text"},{"description":"(Optional) User's email. Add the user's email if you want to send emails from the promotion. It is useful if you want to send automatic emails with coupons, to say thank you, etc.
\n","equals":true,"key":"email","value":"{{email}}"}]},"url":"https://wl.easypromosapp.com/api/autologin/:promotion_id","description":"Send user data via post to a promotion to register as a new participant or to get a session of an already registered user. You will get as a response a unique access code for that participant.
\nResponse: JSON format
\nThis method is also available as a Client side call via Javascript. Server side call is recommended. More information
\n\n","urlObject":{"protocol":"https","path":[":promotion_id"],"host":["wl.easypromosapp.com/api/autologin"],"query":[],"variable":[{"description":{"content":"Promotion ID
\n","type":"text/plain"},"type":"string","value":"{{promotion_autologin_id}}","key":"promotion_id"}]}},"response":[{"id":"ad5ddeba-82bd-4a6f-a7c0-cda0d717b2b8","name":"Auto login - Example Request ","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"(Mandatory) The External ID is the unique identifier for a user. The value can be a string or number. Easypromos always treats it as a string and converts any number value to a string.\nA External ID should be static. If possible, it should be the same value you use to identify the user in your own system.","equals":true,"key":"external_id","value":"{{external_id}}"},{"description":"(Optional) User's first name.","equals":true,"key":"fname","value":"{{fname}}"},{"description":"(Optional) User's last name.","equals":true,"key":"lname","value":"{{lname}}"},{"key":"nickname","value":"{{nickname}}","description":"(Optional) User's nickname. Recommended if you don't want to pass the real first name and last name.","type":"text"},{"description":"(Optional) User's email. Add the user's email if you want to send emails from the promotion. It is useful if you want to send automatic emails with coupons, to say thank you, etc.","equals":true,"key":"email","value":"{{email}}"}]},"url":{"raw":"https://wl.easypromosapp.com/api/autologin/:promotion_id","protocol":"https","host":["wl.easypromosapp.com/api/autologin"],"path":[":promotion_id"],"variable":[{"key":"promotion_id","value":"{{promotion_autologin_id}}","description":"Promotion ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 21 Oct 2020 13:30:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=cif49crq30b3s9r09d7e5jqh90; expires=Thu, 22-Oct-2020 13:30:07 GMT; Max-Age=86400; path=/; samesite=none; domain=.easypromosapp.com; secure; HttpOnly"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"registered\": false,\n \"lt\": \"$5$dGF7emr9XUTj6FtE$WEjPgDdJjoFcb0vEmOnN9btgsJFyu0Hzys61WM4yvA9\"\n}"}],"_postman_id":"0363be02-f395-4161-819f-329b40f6ccc4"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"access_token"},{"key":"value","value":"