v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Client

Clients.update

Modifies Client or Clients with given id(s)

patch/entities/Clients/{id}

Path parameters

idstring uuid required

ID of Client to update

Query parameters

validation-levelinteger

Specify validation level of Client on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Customer, 1 - Support

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

Modification confirmation. Returns resulting Client

successboolean

True when response 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"
  }
}