Updating Client Details via Partial PATCH Requests

This document explains how to review the API documentation for performing partial updates to a client resource using JSON Patch operations, including understanding the required path parameters and the structure of the request body.

Step 1: Review Required Path Parameters

Locate the API documentation section that describes partial client updates (PATCH endpoint for client resources).

Identify and review the path parameters needed to target a specific client record, focusing on:

• tenantId – the identifier of the tenant or organization that owns the client.
• clientId – the unique identifier of the client to be updated.

Ensure you understand that both parameters are mandatory to correctly identify the target resource.

Step 2: Examine the JSON Patch Request Body Example

Scroll down in the documentation to the Request body section and inspect the JSON Patch example.

Review each operation in the example, noting how it uses standard JSON Patch fields such as op, path, and value to partially update client details, including:

• Fullname (e.g., /Fullname)
• Gender (e.g., /Gender)
• Email (e.g., /Email)
• Mobile details (e.g., /MobileNumber, /CountryCode)
• Website (e.g., /Website)
• Online status (e.g., /IsOnline)
• Notification preferences (e.g., /Notifications/Email, /Notifications/SMS)

Continue reviewing until you reach the end of the sample payload so you understand all supported fields and how to structure your patch operations.

Updated on: 16/02/2026