{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","description":"sticky.io Restful API offers some new functionality as well as fully restful routes. All request with a payload should be sent as JSON. The authorization used is [Basic Authentication](https://swagger.io/docs/specification/authentication/basic-authentication/)\n\n[Version 1 JSON API](https://developer-prod.sticky.io)\n\n**Requests**\n\nAPI requests that call for a request body are expected to be in **JSON Format**.\n\n**Responses**\n\nThe v2 standard JSON responses will usually contain at least the following:\n\n| Field | Data Type | Description |\n| --- | --- | --- |\n| status | String | Status of the API call. \"SUCCESS\" or \"FAILURE\" are possible values. |\n| data | Mixed | Data returned by API call. It could be an object or an array of objects. |\n\n**List Responses**\n\nGET requests that return a list of entities will usually contain the following:\n\n| Field | Data Type | Description |\n| --- | --- | --- |\n| status | String | Status of the API call. \"SUCCESS\" or \"FAILURE\" are possible values. |\n| data | Mixed | Data returned by API call. It could be an object or an array of objects. |\n| current_page | Integer | Current page associated with the dataset returned in `data`. |\n| first_page_url | String | URL that maps to the first paginated list of a given entity. |\n| last_page | Integer | Number of pages in a given dataset. |\n| last_page_url | String | URL that maps to the last paginated list of a given entity. |\n| next_page_url | String | URL that maps to the next paginated list of a given entity. |\n| path | String | URL that maps to the index page of a given entity. |\n| per_page | Mixed | Data returned by API call. It could be an object or an array of objects. |\n| prev_page_url | Mixed | Data returned by API call. It could be an object or an array of objects. |\n| from | Integer | Offset record number lower bound. |\n| to | Mixed | Offset record number upper bound. |\n| total | Integer | Total amount of records that exist for a given entity. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4811546","team":117382,"collectionId":"ef86aea7-73d2-4a65-b467-28938bb07563","publishedId":"TWDamFCD","public":true,"publicUrl":"https://developer-v2.sticky.io","privateUrl":"https://go.postman.co/documentation/4811546-ef86aea7-73d2-4a65-b467-28938bb07563","customColor":{"top-bar":"FFFFFF","right-sidebar":"757575","highlight":"0076FF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/da2e7bed-a359-4a46-b964-9263273d74db/bmV3X2xvZ29fMi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/da2e7bed-a359-4a46-b964-9263273d74db/bmV3X2xvZ29fMi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"757575","highlight":"0076FF"}}]}},"version":"8.10.1","publishDate":"2025-02-14T16:55:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/da2e7bed-a359-4a46-b964-9263273d74db/bmV3X2xvZ29fMi5wbmc=","logoDark":"https://content.pstmn.io/da2e7bed-a359-4a46-b964-9263273d74db/bmV3X2xvZ29fMi5wbmc="}},"statusCode":200},"environments":[{"name":"DNVB Demo","id":"c18cce36-8074-4e03-810d-4a08bb9b7abd","owner":"3906964","values":[{"key":"app_key","value":"dnvbdemo","enabled":true},{"key":"api_ext","value":"/api/v1/","enabled":true},{"key":"api_username","value":"demoapi","enabled":true},{"key":"api_password","value":"NHepu6pkBqbcrU","enabled":true},{"key":"coupon_profile_id","value":"1","enabled":true},{"key":"subscription_id","value":"6e419be223c3eb61e471522ba34cdc60","enabled":true},{"key":"ll_platform_key","value":"687ff99a-b7b6-11e9-9d2b-12f0b4779fbe","enabled":true},{"key":"v2_ext","value":"/api/v2/","enabled":true},{"key":"campaign_id","value":"1","enabled":true},{"key":"product_id","value":"1","enabled":true},{"key":"custom_field_id","value":"1","enabled":true},{"key":"option_id","value":"1","enabled":true},{"key":"variant_id","value":"1","enabled":true},{"key":"coupon_id","value":"1","enabled":true},{"key":"billing_model_id","value":"3","enabled":true},{"key":"offer_id","value":"1","enabled":true},{"key":"offer_configuration_id","value":"1","enabled":true},{"key":"gateway_account_id","value":"1","enabled":true},{"key":"gateway_provider_id","value":"1","enabled":true},{"key":"profile_id","value":"1","enabled":true},{"key":"gateway_profile_id","value":"1","enabled":true},{"key":"prospect_id","value":"1","enabled":true},{"key":"customer_id","value":"1","enabled":true},{"key":"order_id","value":"10001","enabled":true},{"key":"provider_profile_id","value":"1","enabled":true},{"key":"country_id","value":"223","enabled":true},{"key":"contact_id","value":"1","enabled":true},{"key":"address_id","value":"1","enabled":true},{"key":"payment_source_id","value":"1","enabled":true},{"key":"domain","value":"sticky.io","enabled":true},{"key":"shipping_id","value":"1","enabled":true},{"key":"image_id","value":"1","enabled":true},{"key":"category_id","value":"1","enabled":true},{"key":"bearer_token","value":"","enabled":true},{"key":"csrf","value":"","enabled":true},{"key":"filter","value":"email","enabled":true},{"key":"warehouse_id","value":"1","enabled":true},{"key":"v3_ext","value":" /api/v3/","enabled":true},{"key":"new_sub_id","value":"123456","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/08e53375b9db2cd804b8db4e4073bb6049c0514201d71da1a777c9122a799a7f","favicon":"https://res.cloudinary.com/postman/image/upload/v1739552214/team/0695b201d620e902346b989044f0a700.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"DNVB Demo","value":"3906964-c18cce36-8074-4e03-810d-4a08bb9b7abd"}],"canonicalUrl":"https://developer-v2.sticky.io/view/metadata/TWDamFCD"}