POST api/v1/clients

Create new client record on LMS system.

Request Information

Parameters

NameDescriptionAdditional information
value
Client details to create

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "client_id": "sample string 1",
  "primary_user_id": "sample string 2",
  "first_name": "sample string 3",
  "last_name": "sample string 4",
  "email": "sample string 5",
  "phone": "sample string 6",
  "job_title": "sample string 7",
  "mobile": "sample string 8",
  "company_name": "sample string 9",
  "number_of_employees": "sample string 10",
  "street": "sample string 11",
  "city": "sample string 12",
  "post_code": "sample string 13",
  "state": "sample string 14",
  "country_code": "sample string 15",
  "account_type": "sample string 16",
  "account_type_id": 1
}

Response Information

Client record with Id assigned.

Response body formats

application/json, text/json

Sample:
{
  "data": {
    "client_id": "sample string 1",
    "primary_user_id": "sample string 2",
    "first_name": "sample string 3",
    "last_name": "sample string 4",
    "email": "sample string 5",
    "phone": "sample string 6",
    "job_title": "sample string 7",
    "mobile": "sample string 8",
    "company_name": "sample string 9",
    "number_of_employees": "sample string 10",
    "street": "sample string 11",
    "city": "sample string 12",
    "post_code": "sample string 13",
    "state": "sample string 14",
    "country_code": "sample string 15",
    "account_type": "sample string 16",
    "account_type_id": 1
  },
  "errors": {
    "messages": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  }
}