Profile

Member profile information

accountIdstringrequired

Account identifier

Example: AIQffAsGi8

emailstring

Email address

Example: i.ivanov@example.ru

createdAtstring<date-time>required

Date and time the account was created

Example: 2023-02-26T18:58:36.154+03:00

updatedAtstring<date-time>required

Date and time the account was last modified

Example: 2024-02-26T18:58:36.154+03:00

fullNamestring

Display name

Example: John A. Smith

accountTypeAccountType (string)required

Account type

Possible values: [REGULAR, BOT, GUEST]

Example: REGULAR

accountDetails object

Additional user data

positionstring

Position

Example: Analyst

departmentstring

Department

Example: B2B

phoneNumberstring

Phone number

Example: 88001234567

locationAccountLocation (string)

Location

Possible values: [NOT_SET, OFFICE, HOME, VACATION]

Example: OFFICE

biostring

Brief information

Example: Do not disturb after 8 PM

statusstring

Status

Example: On a business trip

customFields object[]

Arbitrary custom profile fields defined by the user. The order of elements is significant.

Array [

keystringrequired

Field name

Possible values: <= 64 characters

Example: telegram

valuestringrequired

Field value

Possible values: <= 256 characters

Example: @ivanov

]

Profile

{
  "accountId": "AIQffAsGi8",
  "email": "i.ivanov@example.ru",
  "createdAt": "2023-02-26T18:58:36.154+03:00",
  "updatedAt": "2024-02-26T18:58:36.154+03:00",
  "fullName": "John A. Smith",
  "accountType": "REGULAR",
  "accountDetails": {
    "position": "Analyst",
    "department": "B2B",
    "phoneNumber": "88001234567",
    "location": "OFFICE",
    "bio": "Do not disturb after 8 PM",
    "status": "On a business trip",
    "customFields": [
      {
        "key": "telegram",
        "value": "@ivanov"
      }
    ]
  }
}