Create client

Endpoint

POST - /Clients/CreateNewClient

Overview

Use this endpoint to create a new HelpMaster client.

Input Parameters

firstName

String. The first name of the client.

lastName

String. The last name of the client.

email

String. The email of the client.

phone

String. The phone of the client.

dob

JSON date format. The date of birth of the client.

jobTitle

String. The job title of the client.

timeZoneID

String. A valid timezone ID as found in the database table “tblTimeZones.ID”.

gender

String or Integer. The gender of the client. Can be a valid text-based gender that exists in the database, or a PKID, or a sys_code

address

Address object. The address of the client.

notes

String. Additional notes of the client.

Example

{
  "firstName": "Adam",
  "lastName": "Freeman",
  "email": "adam@wizbangwidgets.com",
  "phone": "333-666-332",
  "dob": "2091-06-23",
  "jobTitle": "Software Developer",
  "timeZoneID": "AUS Eastern Standard Time",
  "gender": "male",
  "address": {
    "street": "14433 Northbourne Avenue",
    "city": "Braddon",
    "postCode": "2602",
    "location": "Level 2",
    "state": "ACT",
    "country": "Australia"
  },
  "notes": "Web API specialist"
}

Successful

A successful call will result in a 200 return code, as well as the the following response body.

{
  "success": true,
  "failMessage": "",
  "clientID": "FreemanA",
  "clientPKID": 5013
}