VUZDevelopers

Update a client

PATCH
/clients/{id}

Updates an existing client with partial data. All fields are optional - only provided fields will be updated.

Updatable Fields:

  • name: Client name or business name
  • type: Client type (private, osek_morshe, company_ltd)
  • phone: Contact phone number
  • email: Contact email
  • address: Physical address
  • vatNumber: Israeli VAT number (9 digits)
  • contactPerson: Contact person name
  • notes: Additional notes
  • isActive: Active status flag

VAT Number Validation: When changing client type to osek_morshe or company_ltd, VAT number becomes required. VAT number must be exactly 9 digits.

Multi-Tenant Security: Only users who own the business that this client belongs to can update this client.

Example Use Cases:

  • Update client address: "רחוב הרצל 100, ירושלים"
  • Add VAT number when client becomes registered business
  • Update contact person or phone number
  • Mark client as inactive without deleting

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Client unique identifier (UUID)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/clients/770e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "770e8400-e29b-41d4-a716-446655440000",  "name": "דוד כהן",  "type": "private",  "phone": "+972-50-7654321",  "email": "david.cohen@example.com",  "address": "רחוב דיזנגוף 50, תל אביב, 6433109",  "vatNumber": "512345678",  "contactPerson": "שרה לוי",  "notes": "לקוח VIP - תנאי תשלום מיוחדים",  "isActive": true,  "origin": "web",  "businessId": "660e8400-e29b-41d4-a716-446655440000",  "userId": "550e8400-e29b-41d4-a716-446655440000",  "createdAt": "2025-01-10T08:00:00.000Z",  "updatedAt": "2025-11-06T14:30:00.000Z",  "portalEnabled": false,  "portalSlug": "my-business",  "portalUrl": "https://app.vuz.co.il/portal/my-business",  "portalLastLoginAt": "2019-08-24T14:15:22Z",  "portalInviteSentAt": "2019-08-24T14:15:22Z"}