latestOpenAPI 3.1.12026-07-268973189.3 KB

27006cfef4d8

Clients

Create a new client

Creates a new client/company in your CRM. The client will be assigned to the user associated with your API key.

post/clients

Request body

type'company' | 'contact'

Client type: company for companies, contact for contacts

namestring

Company name (required for companies, optional for contacts)

firstNamestring

First name (required for contacts)

lastNamestring

Last name (optional for contacts)

salutationstring

Title (Mr., Mrs., Dr., etc.)

phonestring

Phone number with country code

emailstring email nullable

Email address

jobTitlestring

Job title or position

{"stackTrail":"paths:/clients:post:requestBody:content:application/json:schema:properties:website:anyOf","oasType":"schema","type":"unknown","description":"Company website URL","nullable":true}

taxNumberstring nullable

Tax ID or VAT number

openingBalancenumber

Starting account balance (defaults to 0)

Response

idstring required

Client public ID

numberstring required

Auto-generated client number

namestring required

Client name

type'company' | 'contact' required

Client type

firstNamestring nullable

First name (for contacts)

lastNamestring nullable

Last name (for contacts)

emailstring nullable

Email address

phonestring nullable

Phone number

websitestring nullable

Website URL

stageIdstring nullable

Client stage public ID

createdAtstring date-time required

When the client was created

customFieldsobject nullable

Custom field values