API list

Get a visitor

You can acquire user information by linking from REST API.

Request URL
http://app.chatplus.jp/api/v1/get_lead?[parameter]=[value]……

In [Parameter] of the URL, enter a parameter from [Input parameters] list.

List of input parameters

List of output parameters

Example）If you specify the registration date and get the visitor information registered after the specified date, the URL will display as below:
http://app.chatplus.jp/api/v1/get_lead?created_date_start=20170223

Modify the visitor

Visitor information can be updated by linking from REST API or tag method.

REST API

Request URL
http://app.chatplus.jp/api/v1/update_user?[parameter]=[value]……

In [Parameter] of the URL, enter a parameter from [Input parameters] list.
In [value], enter the value (Type) from [Input parameters] list.

List of imput parameters

List of output parameters

Example)
http://app.chatplus.jp/api/v1/update_user?email=aa@×××.jp&name=John Parker
※URL encode with UTF-8 of [value] part.

Tag method

You can link by adding the following code to the chat window code. You can edit the information of registered visitors.

d["__cp_p"]={
  "chatName": "Name",
  "perhapsCompanyName": "Company name",
  "score": 10,
  "scoreType": "+",
  "tagsAdd": ["Tag1", "Tag2"],
  ...
};
d["__cp_f"]={
  "Free items1": "Value1",
  "Free items2": "Value2",
  ...
};

You can check the chat window code from [General]>[Chat window] on the left side of the setting screen.