Users

🔒 Создание или обновление профиля пользователя.

Создание или обновление профиля пользователя.

Access: authorized (10 ) · allowNullCompany: true · Scope: write

Allows: user:update, user:personal, user:documents, user:employment (все обязательны; проверка в команде по ресурсу из запроса)

TypeScript (copy-paste)

POST /user/update

<details open><summary><b>Params</b></summary>
export interface UserUpdateParams {
  ID: string
}
</details> <details open><summary><b>Body (Partial)</b></summary>
// Patch-body: все поля опциональны (Valid.Patch)
export type UserUpdateBody = Partial<UserDto>

export interface UserUpdateBodyFields {
  ID?: string
  /** Phone number */
  phone?: string | null
  email?: string | null
  auth?: Record<string, any> | null
  avatarFID?: string
  firstName?: string
  lastName?: string
  patronymic?: string | null
  gender?: User_gender | null
  contactInfo?: string | null
  dateOfBirth?: string | null
  address?: {
  country?: string | null
  city?: string | null
  streetAddress?: string | null
} | null
  timeZone?: string | null
  meetingInfo?: {
  zoomEmail?: string | null
} | null
  position?: string | null
  hourCost?: number
  docsEmployment?: Record<string, any> | null
  docsLibrary?: Record<string, any> | null
  isDraft?: boolean
  createDT?: string
  createdUID?: string
  /** Unix timestamp in milliseconds */
  updTS?: number
  updUID?: string
}
</details> <details open><summary><b>Response</b></summary>
export type UserUpdateResponse = IServerResponse<UserDto>

export interface IServerResponse<T = any> {
  code: number
  data: T
  srvTS: number
  rkey: string
}
</details>

Полный файл типов: /docs/types · raw: /docs/api-types.ts

post/user/update

Request

  • Base URL: http://localhost
  • URL: http://localhost/user/update
  • Auth: one of:
    • API key in header sid and API key in header rts and API key in header sig
    • HTTP bearer

Query parameters

IDstring uuid required

Можно передать header ID (сервер мержит headers+query)

Headers

devIDstring uuid required

UUID устройства клиента

tzstring required
Example:Europe/Moscow

Таймзона клиента (IANA или offset)

appstring required
Example:kosmodrom-web

Имя клиентского приложения

appVerstring required
Example:1.0.0

Версия клиента

rKeystring

Уникальный ключ запроса для логов/саппорта

Request body

IDstring uuid
phonestring nullable

Phone number

emailstring nullable
authobject nullable
avatarFIDstring uuid
firstNamestring
lastNamestring
patronymicstring nullable
gender'male' | 'female'

male = "male", female = "female"

contactInfostring nullable
dateOfBirthstring date-time nullable
timeZonestring nullable
positionstring nullable
hourCostnumber
docsEmploymentobject nullable
docsLibraryobject nullable
isDraftboolean
createDTstring date-time
createdUIDstring
updTSinteger

Unix timestamp in milliseconds

updUIDstring

Response

OK — IServerResponse<UserDto>

codeinteger required
srvTSinteger required

Server timestamp (ms)

rkeystring required

Request key

Example response

{
  "code": 200
}

Changes

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