Edit Client

Updates an existing client by ID. You can provide only the fields you want to update.

Path Parameters:

id: Client ID (required)

Request Body Fields:

The request body allows partial updates. You only need to include the fields you want to change.

Client Object:

business_name (string): Business name

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

active (integer): Status (0: inactive, 1: active)

custom_fields (object): Custom field values

Response:

{
  "result": "success",
  "code": 200,
  "data": {
    "Client": {
      "id": 15,
      // Updated client fields...
    }
  },
  "message": "Client updated successfully"
}

curl --location -g --request PUT '{{subdomain}}/api2/api2/clients/{{id}}.json' \ --header 'Content-Type: text/plain' \ --data-raw '{ "Client": { "business_name": "ACME Corporation International", "phone1": "555-9999", "email": "updated.email@example.com", "website": "https://acmecorp-intl.example.com", "notes": "Global enterprise client - priority support", "custom_fields": { "industry": "Technology and Manufacturing", "annual_revenue": "$50M+" } } }'

{ "result": "success", "code": 200, "data": { "Client": { "id": 15, "business_name": "ACME Corporation", "phone1": "555-5678", "email": "updated.email@example.com", "modified": "2023-03-24 09:15:22" } }, "message": "Client updated successfully" }

Request

Responses