Clients

Adding a Client

The Client Object

Attributes
id	integer		Unique identifier for the object.
name	string (maxLength=128)	required	The busniess name.
owner	string (maxLength=128)	optional	The business owner's name.
street	string (maxLength=128)	required	The business street.
suite	string (maxLength=32)	optional	The business suite.
hours			The business hours.
city	string (maxLength=128)	required	The business city.
state	string (maxLength=64)	required	The business state.
zipcode	string (maxLength=32)	required	The business zipcode.
phone	string (maxLength=32)	required	The business phone number.
phoneAlt	string (maxLength=32)	optional	The business additional phone number.
fax	string (maxLength=32)	optional	The business fax number.
website	string (maxLength=32)	optional	The business website.
email	string (maxLength=32)	optional	The business email address.
facebook	string (maxLength=32)	optional	The business facebook url.
twitter	string (maxLength=32)	optional	The business twitter url.
linkedin	string (maxLength=32)	optional	The business linkedIn url.
years	string (maxLength=32)	optional	Number of years in business.
description	string	optional	The business description.
payment	string	optional	Payment Types Accepted by the business.
license	string (maxLength=64)	optional	The business license.
keyword1	string (maxLength=64)	optional	The business keyword 1.
keyword2	string (maxLength=64)	optional	The business keyword 2.
keyword3	string (maxLength=64)	optional	The business keyword 3.
keyword4	string (maxLength=64)	optional	The business keyword 4.
keyword5	string (maxLength=64)	optional	The business keyword 5.
keyword1_location	string (maxLength=128)	optional	The business keyword 1 location.
keyword2_location	string (maxLength=128)	optional	The business keyword 2 location.
keyword3_location	string (maxLength=128)	optional	The business keyword 3 location.
keyword4_location	string (maxLength=128)	optional	The business keyword 4 location.
keyword5_location	string (maxLength=128)	optional	The business keyword 5 location.
notes	string	optional	Internal notes about the business.
custom1	string (maxLength=64)	optional	The custom1 field is for internal usage and replaces fkc1 in API Version 1.
custom2	string (maxLength=64)	optional	The custom2 field is for internal usage and replaces fkc2 in API Version 1.
custom3	string (maxLength=64)	optional	The custom3 field is for internal usage and replaces fkc3 in API Version 1.
custom4	string (maxLength=64)	optional	The custom4 field is for internal usage and replaces fkc4 in API Version 1.
custom5	string (maxLength=64)	optional	The custom5 field is for internal usage and replaces fkc5 in API Version 1.

Example Request

POST /legacyclients HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded

name=Gina+Pizza&street=3142+W+Balboa+Blvd&city=Newport+Beach&state=CA&zipcode=92663&phone=(949)+723-4462

Example Response

{
    "status": 200,
    "success": true,
    "error": null,
    "data": {
        "status": "Inactive",
        "country": "US",
        "id": 12345,
        "name": "Gina's Pizza",
        "partnerUsername": "dev@lssdev.com",
        "street": "3142 W Balboa Blvd",
        "city": "Newport Beach",
        "state": "CA",
        "zipcode": "92663",
        "phone": "(949) 723-4462",
        "hide": "false",
        "createdAt": "2017-12-12T23:59:44.077Z",
        "publicKey": "e343f4531abf70d03706727af93006c8",
        "partner": 7
    }
}

Updating a Client

Example Request

POST /legacyclients/3201926 HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded


name=Gina's+Pizza&street=3142+W+Balboa+Blvd&city=Newport+Beach&state=CA&zipcode=92663&phone=(949)+723-4463