Welcome to the Ready Reviews API documentation.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25361963","collectionId":"7b4a1797-a7e4-4b93-8449-c515c7340583","publishedId":"2s93Xzw2bS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-04-17T18:22:35.000Z"},"item":[{"name":"API","item":[{"name":"addCustomer","id":"46718236-5ef1-4c93-992d-cd7d3722b02f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Apikey\":\"your_api_key\",\r\n \"customer_name\":\"Test Person\",\r\n \"phone_number\":\"855-555-1234\",\r\n \"email_id\": \"test@outlook.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://reputationlync.com/app/api/customer/addCustomer","description":"Used to add a single customer to our system.
\ncustomer_name is a required field
\nThe submission must include at least one of (but can include both) the phone_number and/or email_id field.
\nApikey (required): The Apikey of the account.customer_name (optional): Name of the customeremail_id (optional): Customer E-Mail Address (Note that at least one of email or phone_number must be provided. Both cannot be blank)phone_number (optional): Contact number of the customer.whatsapp_enabled (optional): Indicate if the Phone Number provided is a whatsapp enabled number. (1 or 0)tags (optional): Comma separated list of tags to help identify customers (example: retail,online, etc...)language (optional): Specify the language this customer uses (eg. English, Spanish, etc...). Note that the language needs to be set up in the location language settings first before assigning it to a customer.source (optional): Specify the source of this addition (eg, the name of your software or the software sending the new customer to the Ready Reviews API. Defaults to 'API'.source_xref_id (optional): The Customer or transaction ID in your system.Simple function to validate an API key. The response will return success or specific errors as to why the key is not valid (such as suspended account, API limit exceeded, etc...).
\n","urlObject":{"protocol":"https","path":["app","api","customer","validateApiKey"],"host":["reputationlync.com"],"query":[],"variable":[]}},"response":[{"id":"0377b86d-f78a-4e71-bb02-4370d5d2ab76","name":"validateApiKey_success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Apikey\":\"your_api_key\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://reputationlync.com/app/api/customer/validateApiKey"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 17 Apr 2023 18:34:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"result\":\"API Key is valid!\",\"userId\":\"607\"}"},{"id":"f5455744-c8e6-4ad0-b0ba-63781a8b7ccc","name":"validateApiKey_invalid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Apikey\":\"your_api_key\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://reputationlync.com/app/api/customer/validateApiKey"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 17 Apr 2023 18:35:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"error\",\"result\":\"Invalid API Key\"}"}],"_postman_id":"d29ae242-4854-443e-8610-ee1403ab793b"},{"name":"listCustomer","id":"5c16a301-9417-4539-b9c5-dcdf666159ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Apikey\": \"your_api_key\",\r\n \"customer_id\": \"824925\",\r\n \"location_id\": \"\",\r\n \"created_after_date\": \"\",\r\n \"created_before_date\": \"\",\r\n \"created_after_id\": \"\",\r\n \"created_before_id\": \"\",\r\n \"limit\": \"\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://reputationlync.com/app/api/customer/listCustomer","description":"Retrieves a list of the customers based on the search parameters listed below. All of the search parameters are optional and multiple ones can be specified to narrow the search.
\n","urlObject":{"protocol":"https","path":["app","api","customer","listCustomer"],"host":["reputationlync.com"],"query":[],"variable":[]}},"response":[{"id":"a5a8e0bd-f5b6-41a0-9298-a57e5509a3c2","name":"listCustomer_success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Apikey\": \"your_api_key\",\r\n \"customer_id\": \"824925\",\r\n \"location_id\": \"\",\r\n \"created_after_date\": \"\",\r\n \"created_before_date\": \"\",\r\n \"created_after_id\": \"\",\r\n \"created_before_id\": \"\",\r\n \"limit\": \"\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://reputationlync.com/app/api/customer/listCustomer","protocol":"https","host":["reputationlync.com"],"path":["app","api","customer","listCustomer"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 17 Apr 2023 18:46:32 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"result\":[{\"company_name\":\"The Reliable Painter\",\"address_line_1\":\"4813 Laura Jeanne Blvd\",\"first_name\":\"Michael\",\"last_name\":\"Hall\",\"created_date\":\"2023-02-23 15:11:38\",\"number_of_visits\":\"1\",\"customer_name\":\"test two\",\"customer_email\":\"test2@testing.com\",\"phone_number\":null,\"have_open_ratingrequest_email\":\"0\",\"is_send_auto_delay\":\"1\",\"auto_delay_hours\":\"0\",\"auto_delay_days\":\"0\",\"have_rate\":\"0\",\"estimateddate\":\"1677186698\",\"rating\":null,\"feedback\":null,\"customerId\":\"824925\"}],\"userId\":\"607\",\"result_count\":1}"}],"_postman_id":"5c16a301-9417-4539-b9c5-dcdf666159ff"}],"id":"d5b2b16e-a783-48b7-ac67-fbd9f04e6cb1","_postman_id":"d5b2b16e-a783-48b7-ac67-fbd9f04e6cb1","description":""}],"event":[{"listen":"prerequest","script":{"id":"fe254646-b58e-450e-befb-7a678fcb6204","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ed5f488-4a04-4908-a504-fb587269a75a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"api_key","value":"your_api_key","type":"string"},{"key":"endpoint_domain","value":"reputationlync.com","type":"string"}]}