Current user

Make updates to the user to which the login token was issued.

Get profile

get

Retrieve the profile of the currently logged in user.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Responses

200

OK

application/json

A user on the platform.

activeSessionsintegerRequired

The number of logged in session for the user.

avatarUrlstringOptional

URL to the user's profile picture.

biostringOptional

The user's description

createdAtstring · date-timeRequired

When the user was created.

defaultEmailstringOptional

The default email of the user in the list of emails.

idstring · uuidRequired

ID of the user

localestring · locale-bcp47Optional

namestringRequired

The display name for the user

phoneNumberone ofOptional

string · phone-numberOptional

or

string · enumOptionalPossible values:

statusstring · enumRequired

The status of the user

Default: pendingPossible values:

timezonestring · timezoneOptional

The default timezone for the user.

updatedAtstring · date-timeRequired

When the user was last updated.

401

Authentication is required or has failed.

application/json

get

/me

HTTPcURLJavaScriptPython

GET /me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "activeSessions": 1,
  "avatarUrl": "text",
  "badges": [
    "messagebird:cx"
  ],
  "bio": "text",
  "createdAt": "2026-06-16T00:59:06.142Z",
  "defaultEmail": "text",
  "emails": [
    {
      "createdAt": "2026-06-16T00:59:06.142Z",
      "email": "[e-mail]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "passwordSet": true,
      "tokenSet": true,
      "updatedAt": "2026-06-16T00:59:06.142Z",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "verified": true
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identities": [
    {
      "avatarUrl": "text",
      "createdAt": "2026-06-16T00:59:06.142Z",
      "email": "text",
      "id": "text",
      "name": "text",
      "provider": "text",
      "updatedAt": "2026-06-16T00:59:06.142Z"
    }
  ],
  "locale": "text",
  "name": "text",
  "phoneNumber": "text",
  "phoneNumbers": [
    {
      "createdAt": "2026-06-16T00:59:06.142Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "phoneNumber": "text",
      "primary": true,
      "updatedAt": "2026-06-16T00:59:06.142Z",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "verified": true
    }
  ],
  "status": "pending",
  "timezone": "text",
  "updatedAt": "2026-06-16T00:59:06.142Z",
  "userFraudInformation": {
    "score": 1,
    "userId": "text"
  }
}

Update profile

patch

Update the profile of the currently logged in user.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Body

application/json

namestringOptional

The display name for the user

biostringOptional

The user's description

avatarUrlstringOptional

URL to the user's profile picture.

localestring · locale-bcp47Optional

timezonestring · timezoneOptional

The default timezone for the user.

Responses

200

OK

application/json

A user on the platform.

activeSessionsintegerRequired

The number of logged in session for the user.

avatarUrlstringOptional

URL to the user's profile picture.

biostringOptional

The user's description

createdAtstring · date-timeRequired

When the user was created.

defaultEmailstringOptional

The default email of the user in the list of emails.

idstring · uuidRequired

ID of the user

localestring · locale-bcp47Optional

namestringRequired

The display name for the user

phoneNumberone ofOptional

string · phone-numberOptional

or

string · enumOptionalPossible values:

statusstring · enumRequired

The status of the user

Default: pendingPossible values:

timezonestring · timezoneOptional

The default timezone for the user.

updatedAtstring · date-timeRequired

When the user was last updated.

422

The request contains invalid parameters or body fields.

application/json

patch

/me

HTTPcURLJavaScriptPython

PATCH /me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "text",
  "bio": "text",
  "avatarUrl": "text",
  "locale": "text",
  "timezone": "text"
}

{
  "activeSessions": 1,
  "avatarUrl": "text",
  "badges": [
    "messagebird:cx"
  ],
  "bio": "text",
  "createdAt": "2026-06-16T00:59:06.142Z",
  "defaultEmail": "text",
  "emails": [
    {
      "createdAt": "2026-06-16T00:59:06.142Z",
      "email": "[e-mail]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "passwordSet": true,
      "tokenSet": true,
      "updatedAt": "2026-06-16T00:59:06.142Z",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "verified": true
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identities": [
    {
      "avatarUrl": "text",
      "createdAt": "2026-06-16T00:59:06.142Z",
      "email": "text",
      "id": "text",
      "name": "text",
      "provider": "text",
      "updatedAt": "2026-06-16T00:59:06.142Z"
    }
  ],
  "locale": "text",
  "name": "text",
  "phoneNumber": "text",
  "phoneNumbers": [
    {
      "createdAt": "2026-06-16T00:59:06.142Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "phoneNumber": "text",
      "primary": true,
      "updatedAt": "2026-06-16T00:59:06.142Z",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "verified": true
    }
  ],
  "status": "pending",
  "timezone": "text",
  "updatedAt": "2026-06-16T00:59:06.142Z",
  "userFraudInformation": {
    "score": 1,
    "userId": "text"
  }
}

Delete profile

delete

Delete the profile of the currently logged in user. Essentially deleting your account with the platform.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Responses

202

OK

delete

/me

HTTPcURLJavaScriptPython

DELETE /me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

202

OK

No content