Add New Client

Creates a new client in the system.

Request Body Fields:

Required fields are marked with an asterisk (*)

Client Object:

type* (integer): Client type (1: individual, 2: business)

business_name* (string): Business name (required for type 2)

first_name* (string): First name

last_name* (string): Last name

email* (string): Email address

password (string): Password for client portal access

phone1 (string): Primary phone number

phone2 (string): Secondary phone number

address1 (string): Street address line 1

address2 (string): Street address line 2

city (string): City

state (string): State/province

postal_code (string): Postal/ZIP code

country_code* (string): 2-letter country code (e.g., US, UK)

website (string): Website URL

tax_registration (string): Tax registration number

notes (string): Internal notes about the client

group_id (integer): Client group ID

custom_fields (object): Custom field values

Response:

{
  "result": "success",
  "code": 201,
  "data": {
    "Client": {
      "id": 17,
      // Other client fields...
    }
  },
  "message": "Client created successfully"
}

curl --location -g --request POST '{{subdomain}}/api2/api2/clients.json' \ --header 'Content-Type: text/plain' \ --data-raw '{ "Client": { "type": 2, "business_name": "TechStart Corp", "first_name": "Michael", "last_name": "Johnson", "email": "michael.johnson@techstart.com", "password": "securepassword123", "phone1": "555-7890", "phone2": "555-0987", "address1": "789 Innovation Blvd", "address2": "Floor 4", "city": "San Francisco", "state": "CA", "postal_code": "94107", "country_code": "US", "website": "https://techstart.example.com", "tax_registration": "98-7654321", "notes": "New technology startup client", "group_id": 2, "custom_fields": { "industry": "Software Development", "referral_source": "Conference" } } }'

{ "result": "success", "code": 201, "data": { "Client": { "id": 17, "type": 2, "business_name": "ACME Corp", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "created": "2023-03-23 15:30:42", "modified": "2023-03-23 15:30:42", "active": 1 } }, "message": "Client created successfully" }

Request

Responses