{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fd71acd1-2e41-4991-8789-3edfd258479a","name":"Autoklose API","description":"## Introduction\n\nThis is the documentation for Autoklose REST API. The requests and the responses are expected to be in JSON format.\n\n## Usage\n\nGenerate a token from API page [https://app.autoklose.com/integrations](https://app.autoklose.com/integrations)  \nUse it as a URI parameter\n\n```\napi_token={{your_api_token}}\n\n ```\n\nKeep your API token safe.\n\n## Pagination\n\nThe pagination is available for certain GET routes where expected results are possible to go over 25 items. Some examples are getting a list of campaigns, getting a list of contacts, etc. Each route that uses pagination is marked as such in the documentation below.  \nEach paginated request has a specific JSON structure that might look something like this:\n\n```\n{\n    \"data\": [\n        {\n            \"id\": 617,\n            ...\n        },\n        {\n            \"id\": 618,\n            ...\n        },\n        ... (25 results)\n    ],\n    \"links\": {\n        \"first\": \"https://api.autoklose.com/api/campaigns?page=1\",\n        \"last\": \"https://api.autoklose.com/api/campaigns?page=2\",\n        \"prev\": null,\n        \"next\": \"https://api.autoklose.com/api/campaigns?page=2\"\n    },\n    \"meta\": {\n        \"current_page\": 1,\n        \"from\": 1,\n        \"last_page\": 2,\n        \"path\": \"https://api.autoklose.com/api/campaigns\",\n        \"per_page\": 25,\n        \"to\": 45,\n        \"total\": 45\n    }\n}\n\n ```\n\nThe results from data are purposefully omitted. Additional two results are returned, links and meta. Links contain information about which page is one that is currently requested, which one would be the last, previous and the next. In order to make a successful pagination request, it is expected to follow the link for the next link. Meta contains information about the current page, what is the first item number in the request, the last page, the current path, how many items are per one page, until which item results are returned and how many are in total. Using this information, it’s easier to keep track of paginated requests.\n\nIn general, there are two parameters related to the pagination:\n\n- page (default value 1)\n    \n- per_page (default value 25, maximum value 100)\n    \n\nUltimately, what can be seen from the example is that the first 25 campaigns are returned, there are a total of 45 and the next request to get the rest of the campaigns would be at [https://api.autoklose.com/api/campaigns?page=2](#).\n\n## Expansion\n\nThe idea behind expansion is that, by default, it doesn't return all relationships of the requested resource. For example, while retrieving the list of campaigns, there might not be the need to get all available statistics for the campaign or all recipients of the campaign, etc. This parameter is available on the most of the API requests, and applies to the response of that request only. There are two ways of using it:\n\n- As a comma separated string\n    \n    expand=user,statistics\n    \n- As an array\n    \n    expand\\[\\]=user&expand\\[\\]=statistics\n    \n\nIt is allowed to combine expansions or just use a single one.\n\n## Changelog\n\n**1.2.0** - 2025-07-22\n\n- Added - Saved Emails to the documentation\n    \n- Added - Get request - [Get searchable a list of all saved emails](#f4ef9555-ea84-4cfd-af97-cd52b5f207eb)\n    \n- Added - Get request - [Get a single saved email](#fa59147c-48b2-49b8-8f7a-c112d74c651b)\n    \n- Added - Patch request - [Publish/Draft all saved emails](#ed7a9308-bd17-4dc9-b9ed-7057af71a809)\n    \n- Added - Post request - [Create a saved email](#49c710d0-e44c-486b-8e30-1e84b815d784)\n    \n- Added - Post request - [Create a saved email based on an existing campaign email](#8356bae2-8759-4fce-8365-f81fcdbf61c3)\n    \n- Added - Post request - [Create a saved email based on an existing template email](#1faf3fca-b461-4676-9b54-c386deb2b059)\n    \n- Added - Post request - [Apply a saved email to an existing campaign or template email](#ef2ac24c-2d50-4dd8-bf4c-4dc74e4fb5c0)\n    \n- Added - Delete request - [Delete a saved email](#a246023d-62da-43da-85fe-5c19ae7ae5b5)\n    \n- Updated - Example(s) - [Create template email](#914317e4-e1da-4444-80b4-2a958899e6f0)\n    \n- Updated - Example(s) - [A list of all templates](#695e505e-c23c-4b82-b28e-5f2ad4916f29)\n    \n- Updated - Example(s) - [Get a single template](#fd9836f2-8c0d-4d1c-bab2-4b974f5270f0)\n    \n- Updated - Example(s) - [Create a template](#ae21cd4a-9d3f-4ca3-84da-e18d9fb2fec6)\n    \n- Updated - Example(s) - [Update a template](#28f2fe79-df4c-4d90-a515-a848f628a9ec)\n    \n\n**1.1.0** - 2025-02-20\n\n- Added - Post request - [Respond to a reply](#0aee3892-be67-43dc-a4e7-25e3490ce7af)\n    \n- Added - Post request - [Reply-all to a reply](#19a46511-7c61-434c-9a0e-eb53c31e8937)\n    \n- Added - Post request - [Forward to a reply](#98371f04-16b0-4a84-9fee-cdb89524c90b)\n    \n- Added - Get request - [Download attachment from reply](#62654cd6-329c-496f-a7b0-168f2b28ec0c)\n    \n- Added - Query Param \"subscriptions\" a parameter that defines which webhook type should be fetched - [Get List Webhooks request](#c1fc621d-8ba5-4261-9655-d9af114a472c)\n    \n- Added - Query Param \"campaign_id\" a parameter that defines from which campaign the webhooks should be fetched - [Get List Webhooks request](#c1fc621d-8ba5-4261-9655-d9af114a472c)\n    \n- Added - Query Param \"page\" a parameter that defines which page should be returned, default is 1 - [Get List Webhooks request](#c1fc621d-8ba5-4261-9655-d9af114a472c)\n    \n- Added - Query Param \"per_page\" a parameter that defines how many webhooks should be returned, default is 25 - [Get List Webhooks request](#c1fc621d-8ba5-4261-9655-d9af114a472c)\n    \n- Updated - Example(s) - [Get all replies](#455173a8-9fa9-40d6-a6d8-fc8f1904abc2)\n    \n- Updated - Example(s) - [Get a single reply](#3c137ed2-1548-4c3b-a3ed-41590271df8d)\n    \n\n**1.0.1** - 2025-01-16\n\n- (fix) Ramp-up deactivated on repeated store request\n    \n\n**1.0.0** - 2025-01-13\n\n- Initial release","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3342292","team":364755,"collectionId":"fd71acd1-2e41-4991-8789-3edfd258479a","publishedId":"S1a62mib","public":true,"publicUrl":"https://api.aklab.xyz","privateUrl":"https://go.postman.co/documentation/3342292-fd71acd1-2e41-4991-8789-3edfd258479a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-05-29T08:00:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Autoklose API Live","id":"6374feac-910d-4ae2-84ed-6ec18b259ebb","owner":"3342292","values":[{"key":"url","value":"https://api.autoklose.com","enabled":true},{"key":"token","value":"lmXcRX3LObed6fT8YVKkOz0bN36ZVp1K","enabled":true},{"key":"csrf-token","value":"PahHAnuaRURumHUNYIv1DDX4RPcBPOvRdkXLHAEB","enabled":false},{"key":"campaign","value":"{{campaign}}","enabled":true},{"key":"email","value":"{{email}}","enabled":true},{"key":"recipient","value":"{{recipient}}","enabled":true},{"key":"template","value":"{{template}}","enabled":true},{"key":"attachment","value":"{{attachment}}","enabled":true},{"key":"tag","value":"","enabled":true},{"key":"contact","value":"7c854994-3860-11ea-84ac-f23c91033cf5","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/4326c34014cc75f5a8cd85854b6608514438f12be482992384725ed61f05b469","favicon":"https://aklab.xyz/favicon.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":"Autoklose API Live","value":"3342292-6374feac-910d-4ae2-84ed-6ec18b259ebb"}],"canonicalUrl":"https://api.aklab.xyz/view/metadata/S1a62mib"}