Current user

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

Last updated 8 months ago

Was this helpful?

Get profile

Retrieve the profile of the currently logged in user.

get

/me

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/me' \
  --header 'Authorization: Bearer jwt'

200

401

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "bio": "text",
  "activeSessions": 1,
  "createdAt": "2025-02-21T18:14:03.313Z",
  "updatedAt": "2025-02-21T18:14:03.313Z",
  "defaultEmail": "text",
  "avatarUrl": "text",
  "locale": "text",
  "timezone": "text",
  "userFraudInformation": {
    "score": 1,
    "userId": "text"
  },
  "status": "pending",
  "emails": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "hello@example.com",
      "verified": true,
      "passwordSet": true,
      "tokenSet": true,
      "createdAt": "2025-02-21T18:14:03.313Z",
      "updatedAt": "2025-02-21T18:14:03.313Z"
    }
  ],
  "identities": [
    {
      "id": "text",
      "name": "text",
      "email": "text",
      "avatarUrl": "text",
      "provider": "text",
      "createdAt": "2025-02-21T18:14:03.313Z",
      "updatedAt": "2025-02-21T18:14:03.313Z"
    }
  ],
  "phoneNumbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "phoneNumber": "text",
      "verified": true,
      "primary": true,
      "createdAt": "2025-02-21T18:14:03.313Z",
      "updatedAt": "2025-02-21T18:14:03.313Z"
    }
  ],
  "badges": [
    "messagebird:cx"
  ],
  "phoneNumber": "text"
}

Update profile

Update the profile of the currently logged in user.

patch

/me

Authorizations

Body

namestring

The display name for the user

biostring

The user's description

avatarUrlstring

URL to the user's profile picture.

localestring · locale-bcp47

timezonestring · timezone

The default timezone for the user.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/me' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json'

200

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "bio": "text",
  "activeSessions": 1,
  "createdAt": "2025-02-21T18:14:03.313Z",
  "updatedAt": "2025-02-21T18:14:03.313Z",
  "defaultEmail": "text",
  "avatarUrl": "text",
  "locale": "text",
  "timezone": "text",
  "userFraudInformation": {
    "score": 1,
    "userId": "text"
  },
  "status": "pending",
  "emails": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "hello@example.com",
      "verified": true,
      "passwordSet": true,
      "tokenSet": true,
      "createdAt": "2025-02-21T18:14:03.313Z",
      "updatedAt": "2025-02-21T18:14:03.313Z"
    }
  ],
  "identities": [
    {
      "id": "text",
      "name": "text",
      "email": "text",
      "avatarUrl": "text",
      "provider": "text",
      "createdAt": "2025-02-21T18:14:03.313Z",
      "updatedAt": "2025-02-21T18:14:03.313Z"
    }
  ],
  "phoneNumbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "phoneNumber": "text",
      "verified": true,
      "primary": true,
      "createdAt": "2025-02-21T18:14:03.313Z",
      "updatedAt": "2025-02-21T18:14:03.313Z"
    }
  ],
  "badges": [
    "messagebird:cx"
  ],
  "phoneNumber": "text"
}

Delete profile

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

delete

/me

Authorizations

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/me' \
  --header 'Authorization: Bearer jwt'

202

No body