Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Clients

Create a new Client

Beta: This endpoint is subject to change and may contain bugs. Breaking changes may occur without notice.

Creates a new client and returns the created client object. Either email or primaryPhone must be provided. The client's service location is created from addressDetails. Optionally accepts a billing address, an ad group, a parent client, tax exemption details, and custom field values.

post/v2/clients

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

firstNamestring required

The first name of the client.

lastNamestring

The last name of the client.

companyNamestring

The company name of the client.

emailstring

The email address of the client. Either email or primaryPhone must be provided.

primaryExtstring

The extension number for the primary phone number.

primaryPhonestring

The primary phone number of the client. Either email or primaryPhone must be provided.

secondaryExtstring

The extension number for the secondary phone number.

secondaryPhonestring

The secondary phone number of the client.

adGroupIdstring

The ID of the ad group (prefix AG-).

allowBillingboolean

Whether the client allows billing. Defaults to the account-level setting when omitted.

parentClientIdstring

The ID of the parent client (prefix CL-). The created client is set as a sub-client of it.

taxExemptboolean

Whether the client is tax exempt.

taxExemptReason'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | '14' | '15' | '99'

The tax exemption reason code. Can only be provided when taxExempt is true; defaults to 99 (Other) when taxExempt is true and no reason is provided. Allowed values: 1 = Federal Government, 2 = State Government, 3 = Local Government, 4 = Tribal Government, 5 = Charitable Organization, 6 = Religious Organization, 7 = Educational Organization, 8 = Hospital, 9 = Resale, 10 = Direct Pay Permit, 11 = Multiple Points Of Use, 12 = Direct Mail, 13 = Agricultural Production, 14 = Industrial Production / Manufacturing, 15 = Foreign Diplomat, 99 = Other.

descriptionstring

The description of the client.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "Example Inc.",
  "email": "john.doe@example.com",
  "primaryExt": "123",
  "primaryPhone": "1234567890",
  "secondaryExt": "456",
  "secondaryPhone": "1234567890",
  "addressDetails": {
    "country": "US",
    "state": "NY",
    "city": "New York",
    "zipCode": "10001",
    "address": "123 Main St",
    "unit": "100"
  },
  "billingAddressDetails": {
    "country": "US",
    "state": "NY",
    "city": "New York",
    "zipCode": "10001",
    "address": "123 Main St",
    "unit": "100"
  },
  "adGroupId": "AG-59kGnmvvyamryw1O",
  "allowBilling": true,
  "parentClientId": "CL-OvmDp2yvv1yqMwRl",
  "taxExemptReason": "9",
  "description": "This is a description",
  "customFields": [
    {
      "id": "CF-DNr3zVoKWod6abEn",
      "value": "test"
    }
  ]
}

Response

The created client.

idstring

The ID of the client (prefix CL-).

serialIdnumber

The serial ID of the client.

firstNamestring

The first name of the client.

lastNamestring

The last name of the client.

fullNamestring

The full name of the client.

companyNamestring

The company name of the client.

emailstring

The email address of the client.

primaryExtstring

The primary phone extension of the client.

primaryPhonestring

The primary phone of the client.

secondaryExtstring

The secondary phone extension of the client.

secondaryPhonestring

The secondary phone of the client.

countrystring

The country of the client.

statestring

The state of the client.

citystring

The city of the client.

zipcodestring

The zipcode of the client.

unitstring

The unit of the client.

addressstring

The address of the client.

serviceAddressstring

The service address of the client.

billingAddressstring

The billing address of the client.

allowBillingboolean

Whether the client allows billing.

createdstring

The creation date of the client.

Example response

{
  "id": "CL-OvmDp2yvv1yqMwRl",
  "serialId": 1023,
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "companyName": "John Doe Inc.",
  "email": "john.doe@example.com",
  "primaryExt": "123",
  "primaryPhone": "1234567890",
  "secondaryExt": "456",
  "secondaryPhone": "1234567890",
  "country": "USA",
  "state": "NY",
  "city": "New York",
  "zipcode": "10001",
  "unit": "100",
  "address": "123 Main St",
  "serviceAddress": "123 Main St, New York, NY 10001",
  "billingAddress": "123 Main St, New York, NY 10001",
  "allowBilling": true,
  "adGroup": {
    "id": "AG-71b8d7310acbf8cc",
    "name": "Ad Group 1"
  },
  "tags": [
    {
      "id": "TAG-211d1676f4b90c40",
      "name": "Tag 1",
      "color": "#edce4c"
    }
  ],
  "parentClient": {
    "id": "CL-OvmDp2yvv1yqMwRl",
    "serialId": 1023,
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "companyName": "John Doe Inc.",
    "email": "john.doe@example.com",
    "primaryExt": "123",
    "primaryPhone": "1234567890",
    "secondaryExt": "456",
    "secondaryPhone": "1234567890",
    "country": "USA",
    "state": "NY",
    "city": "New York",
    "zipcode": "10001",
    "unit": "100",
    "address": "123 Main St",
    "serviceAddress": "123 Main St, New York, NY 10001",
    "billingAddress": "123 Main St, New York, NY 10001",
    "allowBilling": true
  },
  "clientContacts": [
    {
      "id": "CLC-211d1676f4b90c40",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "primaryPhone": "1234567890",
      "secondaryPhone": "1234567890",
      "country": "USA",
      "state": "NY",
      "city": "New York",
      "zipcode": "10001",
      "address": "123 Main St",
      "role": "Property Manager",
      "note": "Prefers contact by email."
    }
  ],
  "notes": [
    {
      "id": "CLN-211d1676f4b90c40",
      "note": "Customer requested a follow-up call.",
      "techName": "John Doe",
      "createdAt": "2021-01-01 00:00:00"
    }
  ],
  "customFields": [
    {
      "id": "CF-eYLPK7198xVp6Z8q",
      "fieldName": "Custom Field 1",
      "value": "John Doe"
    }
  ],
  "created": "2026-01-01 00:00:00"
}