Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
User

Update User

Update an existing 'User' record.

patch/User/{id}

Request body

idstring

An ID.

userNamestring

A one-line string.

type'regular' | 'admin' | 'portal' | 'system' | 'super-admin' | 'api'
authMethod'ApiKey' | 'Hmac' nullable
apiKeystring nullable

A one-line string.

secretKeystring nullable

A one-line string.

salutationName'Mr.' | 'Ms.' | 'Mrs.' | 'Dr.' nullable
firstNamestring nullable

A one-line string.

lastNamestring

A one-line string.

isActiveboolean
titlestring nullable

A one-line string.

positionstring nullable

A one-line string.

emailAddressstring nullable

A primary email address.

phoneNumberstring nullable

A primary phone number.

defaultTeamIdstring nullable

An ID of the record of the Team type.

defaultTeamNamestring nullable

A foreign record name.

acceptanceStatusMeetingsstring
acceptanceStatusCallsstring
teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

teamsColumnsobject nullable

An {ID => object} map. Relationship column values.

rolesIdsstring[] nullable

IDs of records of the Role type.

rolesNamesobject nullable

An {ID => record name} map.

portalsIdsstring[] nullable

IDs of records of the Portal type.

portalsNamesobject nullable

An {ID => record name} map.

portalRolesIdsstring[] nullable

IDs of records of the PortalRole type.

portalRolesNamesobject nullable

An {ID => record name} map.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

accountsIdsstring[] nullable

IDs of records of the Account type.

accountsNamesobject nullable

An {ID => record name} map.

accountIdstring nullable
accountNamestring nullable

A foreign record name.

avatarIdstring nullable

An ID of the record of the Attachment type.

avatarNamestring nullable

A foreign record name.

gender'Male' | 'Female' | 'Neutral' nullable
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

dashboardTemplateIdstring nullable

An ID of the record of the DashboardTemplate type.

dashboardTemplateNamestring nullable

A foreign record name.

workingTimeCalendarIdstring nullable

An ID of the record of the WorkingTimeCalendar type.

workingTimeCalendarNamestring nullable

A foreign record name.

layoutSetIdstring nullable

An ID of the record of the LayoutSet type.

layoutSetNamestring nullable

A foreign record name.

lastAccessstring nullable

A timestamp in UTC.

middleNamestring nullable

A one-line string.

emailAddressIsOptedOutboolean
emailAddressIsInvalidboolean
phoneNumberIsOptedOutboolean
phoneNumberIsInvalidboolean

Example request

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "lastAccess": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

userNamestring

A one-line string.

type'regular' | 'admin' | 'portal' | 'system' | 'super-admin' | 'api'
authMethod'ApiKey' | 'Hmac' nullable
apiKeystring nullable

A one-line string.

secretKeystring nullable

A one-line string.

salutationName'Mr.' | 'Ms.' | 'Mrs.' | 'Dr.' nullable
firstNamestring nullable

A one-line string.

lastNamestring

A one-line string.

isActiveboolean
titlestring nullable

A one-line string.

positionstring nullable

A one-line string.

emailAddressstring nullable

A primary email address.

phoneNumberstring nullable

A primary phone number.

defaultTeamIdstring nullable

An ID of the record of the Team type.

defaultTeamNamestring nullable

A foreign record name.

acceptanceStatusMeetingsstring
acceptanceStatusCallsstring
teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

teamsColumnsobject nullable

An {ID => object} map. Relationship column values.

rolesIdsstring[] nullable

IDs of records of the Role type.

rolesNamesobject nullable

An {ID => record name} map.

portalsIdsstring[] nullable

IDs of records of the Portal type.

portalsNamesobject nullable

An {ID => record name} map.

portalRolesIdsstring[] nullable

IDs of records of the PortalRole type.

portalRolesNamesobject nullable

An {ID => record name} map.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

accountsIdsstring[] nullable

IDs of records of the Account type.

accountsNamesobject nullable

An {ID => record name} map.

accountIdstring nullable
accountNamestring nullable

A foreign record name.

avatarIdstring nullable

An ID of the record of the Attachment type.

avatarNamestring nullable

A foreign record name.

gender'Male' | 'Female' | 'Neutral' nullable
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

dashboardTemplateIdstring nullable

An ID of the record of the DashboardTemplate type.

dashboardTemplateNamestring nullable

A foreign record name.

workingTimeCalendarIdstring nullable

An ID of the record of the WorkingTimeCalendar type.

workingTimeCalendarNamestring nullable

A foreign record name.

layoutSetIdstring nullable

An ID of the record of the LayoutSet type.

layoutSetNamestring nullable

A foreign record name.

lastAccessstring nullable

A timestamp in UTC.

middleNamestring nullable

A one-line string.

emailAddressIsOptedOutboolean
emailAddressIsInvalidboolean
phoneNumberIsOptedOutboolean
phoneNumberIsInvalidboolean

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "lastAccess": "2026-11-29 12:34:56"
}