VEvetnio
clients

Update a client (owner)

Updates the fields present in the body and leaves omitted fields unchanged; phoneNumbers replaces the whole list. Fields cannot be set to null; send an empty string to blank a text field. Send at least one field: an empty body currently fails with 500. Repeating the same request has no further effect. Returns 404 when the client does not exist in the workspace.

patch/workspaces/{workspaceId}/clients/{clientId}

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/clients/{clientId}
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the workspace (clinic) that owns the patients and clients. The caller must be a member of it; patients and clients are shared by all members of the workspace.

Example:furunculotic-loud-chihuahua
clientIdstring required

Client (owner) id (UUID) in this workspace. Unknown ids and ids from other workspaces return 404.

Example:e1f2a3b4-c5d6-4789-efab-901234567890

Request body

namestring

New name. The owner's full name, free text.

emailstring

New email address. The owner's email address. Stored as given; the format is not validated.

addressstring

New street address. The owner's street address, free text.

zipCodestring

New postal code. The owner's postal code, free text.

phoneNumbersstring[]

Complete new list of phone numbers; replaces the stored list. Send an empty array to remove all. The owner's phone numbers, stored as given (no normalisation). E.164 format such as +46701234567 is recommended.

Example request

{
  "name": "Alex Morgan",
  "email": "alex.morgan@example.net",
  "address": "4 Mill Lane, Riverside",
  "zipCode": "111 43",
  "phoneNumbers": [
    "+46709876543"
  ]
}

Response

Confirmation that the client was updated.

successboolean required

Always true; failures are returned as errors.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.