{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"57773e0a-c0d6-4cfd-a82b-abcd74f38a79","name":"Reply Agent Public APIs Dev","description":"This API is meticulously crafted to empower our users in efficiently managing their data and seamlessly acquiring additional leads from external systems. Since its launch on December 8, 2023, the API has been actively facilitating enhanced functionality for our users.\n\n# Authorization:\n\nThe Reply Agent API employs a robust token system to ensure the security of requests. To initiate a request, it is imperative to include a token in the header, designated with the key \"Authorization,\" following the format: `Authorization: Bearer`.\n\n## Obtaining a Token:\n\nTo obtain a token, begin by logging into your workspace using your credentials. After successful login, navigate to the Settings option in the main menu. Subsequently, click on Connect -> API from the sidebar. If a key has not already been generated, click on the \"Generate Key\" button.\n\n<img src=\"https://content.pstmn.io/3662ec66-3235-4c96-aeeb-66568aaf6904/MjAyMy0xMi0wN18xNmgwN18yMi5wbmc=\">\n\n# Request\n\nUse the following URL to make your requests:\n\n{{api_url}}\n\n**Note:** You can make 100 requests per minute from a single IP address.\n\n### Response:\n\nUpon receiving your request, the server promptly delivers a response formatted in JSON. This choice is deliberate, as JSON is renowned for its speed and ease of parsing across various programming languages. Our commitment to excellence extends to adhering to the best practices of HTTP status codes, providing a transparent and standardized way to communicate the outcome of your API request.\n\n### Status Codes:\n\nIn managing API responses, we conscientiously employ conventional HTTP response codes to clearly convey the success or failure of each request. To elucidate, status codes falling within the 2xx range signify successful operations, those within the 4xx range denote errors arising from the provided information (e.g., missing required parameters or an unlocatable named calendar), while codes within the 5xx range indicate issues on our servers. This systematic approach enhances the reliability and understanding of the interactions between your application and our API.\n\n### 200 OK\n\nThe request was successful.\n\n### 201 CREATED\n\nNew resources successfully added to the system.\n\n### 202 UPDATED\n\nNew resources successfully updated\n\n### 204 DELETED\n\nThe resource was successfully deleted.\n\n### 400 BAD REQUEST\n\nThe request is not as it was expected by the server like validation problem or some required data is missing.\n\n### 401 UNAUTHORIZED\n\nUnauthorized to serve the request. This code may arise for a couple of reasons\n\n- The Auth Token was either missing or invalid.\n    \n- User account is either suspended or closed.\n    \n- The URL (Referrer) is not under protection list.\n    \n\n### 403 FORBIDDEN\n\nThe resource is forbidden\n\n### 404 NOT FOUND\n\nThe resource you are looking for was not found\n\n## Error Handling\n\nIn case of errors, the response envelops some following data to best describe the error.\n\n| Attribute Name | Description |\n| --- | --- |\n| error | true / false |\n| error_code | If an error occurs in the request or data processing, the response will include an error code. The purpose of the error code is to guide you in taking appropriate actions based on the nature of the error. All error codes are presented in uppercase, with words separated by underscores for clarity. Examples of error codes include UNAUTHORIZED, INVALID_REQUEST, and so forth. |\n| message | This attribute contains an explanation of an error. |\n\n### Sample Successful Response\n\n``` json\n{\n    \"id\": 123456789,\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"email\":\"john.doe@email.com\",\n    .....\n}\n\n ```\n\n### Sample Error Response\n\n``` json\n{\n    \"error\": true,\n    \"error_message\": \"You are not authorized for this request.\",\n    \"error_code\": \"UNAUTHORISED\"\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"27186063","collectionId":"57773e0a-c0d6-4cfd-a82b-abcd74f38a79","publishedId":"2s9YkjC4NL","public":true,"publicUrl":"https://developers.replyagent.com","privateUrl":"https://go.postman.co/documentation/27186063-57773e0a-c0d6-4cfd-a82b-abcd74f38a79","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Reply Agent public API for developers."},{"name":"title","value":"Reply Agent Public API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-12-15T12:28:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Reply Agent Public API","description":"Reply Agent public API for developers."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Reply Agent API Docs","id":"2a63cec1-e61a-416a-9532-18ce45e09360","owner":"27185916","values":[{"key":"api_url","value":"https://ra-bcknd.com/v1","enabled":true,"type":"default"},{"key":"api_key","value":"YOUR_API_KEY","enabled":true,"type":"default"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://replyagent.com/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":"Reply Agent API Docs","value":"27185916-2a63cec1-e61a-416a-9532-18ce45e09360"}],"canonicalUrl":"https://developers.replyagent.com/view/metadata/2s9YkjC4NL"}