Ready Reviews API

Welcome to the Ready Reviews API documentation.

API

POSTaddCustomer

https://reputationlync.com/app/api/customer/addCustomer

Used to add a single customer to our system.

customer_name is a required field

The submission must include at least one of (but can include both) the phone_number and/or email_id field.

Request Parameters

Apikey (required): The Apikey of the account.

customer_name (optional): Name of the customer

email_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.

Bodyraw (json)

json

{
    "Apikey":"your_api_key",
    "customer_name":"Test Person",
    "phone_number":"855-555-1234",
    "email_id": "test@outlook.com"
}

Example Request

curl

curl --location 'https://reputationlync.com/app/api/customer/addCustomer' \
--data-raw '{
    "Apikey":"your_api_key",
    "phone_numbe":"855-555-1234",
    "customer_name":"Test Person",
    "email_id": "test@testcompany.com"
}'

200 OK

Example Response

html

{
  "status": "success",
  "result": "Customer added."
}

Date

Mon, 17 Apr 2023 19:40:10 GMT

Server

Apache

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

ci_session=00171ad0bcae9dae97eea27fed87e74c9ed990b2; expires=Mon, 17 Apr 2023 21:40:10 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax

Keep-Alive

timeout=5, max=500

Connection

Keep-Alive

Transfer-Encoding

chunked

Content-Type

text/html; charset=UTF-8

POSTvalidateApiKey

https://reputationlync.com/app/api/customer/validateApiKey

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...).

Bodyraw (json)

json

{
    "Apikey": "your_api_key"
}

Example Request

curl

curl --location 'https://reputationlync.com/app/api/customer/validateApiKey' \
--data '{
    "Apikey":"your_api_key"
}'

200 OK

Example Response

html

{
  "status": "success",
  "result": "API Key is valid!",
  "userId": "607"
}

Date

Mon, 17 Apr 2023 18:34:10 GMT

Server

Apache

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Keep-Alive

timeout=5, max=500

Connection

Keep-Alive

Transfer-Encoding

chunked

Content-Type

text/html; charset=UTF-8

POSTlistCustomer

https://reputationlync.com/app/api/customer/listCustomer

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.

Bodyraw (json)

json

{
    "Apikey": "your_api_key",
    "customer_id": "824925",
    "location_id": "",
    "created_after_date": "",
    "created_before_date": "",
    "created_after_id": "",
    "created_before_id": "",
    "limit": ""

}

Example Request

curl

curl --location 'https://reputationlync.com/app/api/customer/listCustomer' \
--data '{
    "Apikey": "your_api_key",
    "customer_id": "824925",
    "location_id": "",
    "created_after_date": "",
    "created_before_date": "",
    "created_after_id": "",
    "created_before_id": "",
    "limit": ""

}'

200 OK

Example Response

html

{
  "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
}

Date

Mon, 17 Apr 2023 18:46:32 GMT

Server

Apache

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Keep-Alive

timeout=5, max=500

Connection

Keep-Alive

Transfer-Encoding

chunked

Content-Type

text/html; charset=UTF-8