COcoevera
Client

Clients.update

Changes fields of the Client record with the given id; fields left out keep their values.

patch/entities/Clients/{id}

Request

Path parameters

idstring uuid required

Id of the Client record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

default_unit_idstring uuid

Id of the default sales unit.

master_right_idstring uuid

Id of the assigned user role.

positionstring

Job title or position of the user.

type0 | 1 | 2

Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.

Integer enum value: 0 - Customer, 1 - Support, 2 - Placeholder

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "default_unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "master_right_id": "01234567-abcd-dcba-ffff-000000000000",
  "position": "string",
  "revision": 1
}

Response

The changed Client record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "default_unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "email": "string",
    "first_name": "string",
    "last_active": "2019-01-01T00:00:00",
    "last_name": "string",
    "master_right_id": "01234567-abcd-dcba-ffff-000000000000",
    "middle_name": "string",
    "phone": "string",
    "picture_url": "string",
    "position": "string",
    "region": "string",
    "timezone": "string",
    "revision": 1,
    "default_idp": 1,
    "user_profile_id": 1,
    "timezone_name": "string",
    "name": "string",
    "formatted_name": "string",
    "unit_manager_ids": [
      "01234567-abcd-dcba-ffff-000000000000"
    ],
    "unit_member_ids": [
      "01234567-abcd-dcba-ffff-000000000000"
    ],
    "user_recalculation_state": "InProgress"
  }
}

Changes

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