Back to top

API Documentation

Users

User types

There are 2 types of users in Rechat. Agent and Client. An Agent is a licensed Real Estate Broker who uses Rechat to utilize his workflow.

A client is someone looking for a Real Estate transaction.

There are features built in Rechat to enhance both types of clients use cases.

Shadow Users

Rechat is an open platform. That means we do not want our agents to enforce their clients to install Rechat. That means a Rechat user (mostly clients) should be able to communicate using email or phones.

This means when an agent invites a client using her email address or phone number, we actually create a user object in our database for the client. This way we can track her communication.

Therefore a Shadow User is a user who has been invited to Rechat but has not completed her sign up yet.

It is important to remember that shadow users can use some of the Rechat’s features using Email/Phone.

Lookup login methods

Lookup login methods
POST/users/lookup

Example URI

POST /users/lookup
Request
HideShow
Body
{
  "email": "[email protected]",
  "client_id": "bf0da47e-7226-11e4-905b-0024d71b10fc",
  "client_secret": "secret"
}
Response  404
HideShow
Body
{
  "trace": false,
  "http": 404,
  "message": "No user found with email [email protected]",
  "code": "ResourceNotFound",
  "slack": false
}

Create User

Create User
POST/users

Example URI

POST /users
Request
HideShow
Body
{
  "username": "john",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "user_type": "Agent",
  "password": "$2b$05$v5GWrRzSqGdpWwQctQK61eo5srACJEhTQsOD9z3C0sW16mqN6z4tO",
  "phone_number": "+989124834198",
  "grant_type": "password",
  "cover_image_url": "http://rechat.com/cover_image_url/cover_image_url.png",
  "cover_image_thumbnail_url": "http://rechat.com/cover_image_thumbnail_url/cover_image_thumbnail_url.png",
  "profile_image_url": "http://rechat.com/profile_image_url/profile_image_url.png",
  "profile_image_thumbnail_url": "http://rechat.com/profile_image_thumbnail_url/profile_image_thumbnail_url.png",
  "address": {
    "title": "foo"
  },
  "email_signature": "This is my signature.",
  "client_id": "bf0da47e-7226-11e4-905b-0024d71b10fc",
  "client_secret": "secret",
  "brand": null
}
Response  201
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone_number": "+989124834198",
    "created_at": 1765163668.615029,
    "id": "5b7aa91b-4f4a-43fb-aadd-d0a54c03ee36",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.615052,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": false,
    "timezone": "America/Chicago",
    "user_type": "Client",
    "deleted_at": null,
    "phone_confirmed": false,
    "is_shadow": null,
    "personal_room": "9724e26a-0eed-4658-bb95-2c4340cd94b5",
    "brand": null,
    "fake_email": null,
    "features": null,
    "last_seen_at": null,
    "email_signature": "This is my signature.",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": null,
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "John Doe",
    "abbreviated_display_name": "John",
    "online_state": "Offline",
    "has_password": true
  }
}

Get User

Get User
GET/users/{id}

Example URI

GET /users/5b7aa91b-4f4a-43fb-aadd-d0a54c03ee36
URI Parameters
HideShow
id
string (required) Example: 5b7aa91b-4f4a-43fb-aadd-d0a54c03ee36
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone_number": "+989124834198",
    "created_at": 1765163668.615029,
    "id": "5b7aa91b-4f4a-43fb-aadd-d0a54c03ee36",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.615052,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": false,
    "timezone": "America/Chicago",
    "user_type": "Client",
    "deleted_at": null,
    "phone_confirmed": false,
    "is_shadow": null,
    "personal_room": "9724e26a-0eed-4658-bb95-2c4340cd94b5",
    "brand": null,
    "fake_email": null,
    "features": null,
    "last_seen_at": null,
    "email_signature": "This is my signature.",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": null,
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "John Doe",
    "abbreviated_display_name": "John",
    "online_state": "Offline",
    "has_password": true
  }
}

Get User Roles

Get User Roles
GET/users/self/roles

Example URI

GET /users/self/roles
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [],
  "info": {
    "count": 0,
    "total": 0
  }
}

Update User

Update User
PUT/users/self

Example URI

PUT /users/self
Request
HideShow
Body
{
  "type": "user",
  "username": null,
  "first_name": "updated first name",
  "last_name": "Test",
  "email": "[email protected]",
  "phone_number": "+4368120265807",
  "created_at": 1493115498.770362,
  "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "address_id": null,
  "cover_image_url": null,
  "profile_image_url": null,
  "updated_at": 1493115498.770744,
  "user_status": "Active",
  "profile_image_thumbnail_url": null,
  "cover_image_thumbnail_url": null,
  "email_confirmed": true,
  "timezone": "America/Chicago",
  "user_type": "Admin",
  "deleted_at": null,
  "phone_confirmed": false,
  "is_shadow": false,
  "personal_room": null,
  "brand": null,
  "fake_email": false,
  "features": [
    "Deals"
  ],
  "last_seen_at": null,
  "email_signature": "my signature",
  "daily_enabled": false,
  "email_quota": 30000,
  "website": null,
  "instagram": null,
  "twitter": null,
  "linkedin": null,
  "youtube": null,
  "facebook": null,
  "designation": null,
  "tiktok": null,
  "mfa_enabled": false,
  "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "current_time": "9:14 PM - Sunday Dec 07, 2025",
  "push_allowed": true,
  "agents": null,
  "last_seen_type": null,
  "active_brand": null,
  "display_name": "Unit Test",
  "abbreviated_display_name": "Unit",
  "online_state": "Offline",
  "has_password": true,
  "password": "aaaaaa"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.898077,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": false,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "my signature",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}

Delete User

Delete User
DELETE/users/self

Example URI

DELETE /users/self
Response  204

Change Password

Change Password
PATCH/users/self/password

Example URI

PATCH /users/self/password
Request
HideShow
Body
{
  "old_password": "aaaaaa",
  "new_password": "aabbccddeeff",
  "terminate_sessions": false
}
Response  200

Reset Password

Reset Password
POST/users/reset_password

Example URI

POST /users/reset_password
Request
HideShow
Body
{
  "email": "[email protected]"
}
Response  204

Set Timezone

Set Timezone
PATCH/users/self/timezone

Example URI

PATCH /users/self/timezone
Request
HideShow
Body
{
  "time_zone": "America/Chicago"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.393703,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": false,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "Here is my great signature",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}

Create Phone Verification

Create Phone Verification
POST/phone_verifications

Example URI

POST /phone_verifications
Response  204

Create Email Verification

Create Email Verification
POST/email_verifications

Example URI

POST /email_verifications
Response  204

Upgrade User to Agent

Upgrade User to Agent
POST/users/self/agents

Example URI

POST /users/self/agents
URI Parameters
HideShow
associations
string (required) Example: user.agents
Request
HideShow
Body
{
  "agent": "f7e5a65a-50b5-4249-8b2e-bea7d2115db5",
  "secret": "[email protected]"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.393703,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Agent",
    "deleted_at": null,
    "phone_confirmed": true,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "Here is my great signature",
    "daily_enabled": true,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": [
      {
        "id": "f7e5a65a-50b5-4249-8b2e-bea7d2115db5",
        "email": "[email protected]",
        "mlsid": "00920130",
        "fax": "(972) 264-4703",
        "full_name": "Gholi Sweet",
        "first_name": "Gholi",
        "last_name": "Sweet",
        "middle_name": null,
        "phone_number": "(972) 264-4703",
        "nar_number": "797500044",
        "office_mui": "15512742",
        "status": "Active",
        "office_mlsid": "RCHT01X",
        "work_phone": "(469) 358-8080",
        "generational_name": null,
        "matrix_unique_id": "155155530",
        "updated_at": 1765163668.498998,
        "deleted_at": null,
        "created_at": 1765163668.498998,
        "mls": "NTREIS",
        "license_number": null,
        "designation": null,
        "nrds": "01053140",
        "type": "agent",
        "office_id": null,
        "secret_questions": [
          "(972) XXX-XX03",
          "jewellxxxxxxxxxxxxxal.net",
          "(469) XXX-XX80"
        ]
      }
    ],
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}
Request
HideShow
Body
{
  "agent": "f7e5a65a-50b5-4249-8b2e-bea7d2115db5",
  "secret": "(972) 264-4703"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.393703,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Agent",
    "deleted_at": null,
    "phone_confirmed": true,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "Here is my great signature",
    "daily_enabled": true,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": [
      {
        "id": "f7e5a65a-50b5-4249-8b2e-bea7d2115db5",
        "email": "[email protected]",
        "mlsid": "00920130",
        "fax": "(972) 264-4703",
        "full_name": "Gholi Sweet",
        "first_name": "Gholi",
        "last_name": "Sweet",
        "middle_name": null,
        "phone_number": "(972) 264-4703",
        "nar_number": "797500044",
        "office_mui": "15512742",
        "status": "Active",
        "office_mlsid": "RCHT01X",
        "work_phone": "(469) 358-8080",
        "generational_name": null,
        "matrix_unique_id": "155155530",
        "updated_at": 1765163668.498998,
        "deleted_at": null,
        "created_at": 1765163668.498998,
        "mls": "NTREIS",
        "license_number": null,
        "designation": null,
        "nrds": "01053140",
        "type": "agent",
        "office_id": null,
        "secret_questions": [
          "(972) XXX-XX03",
          "jewellxxxxxxxxxxxxxal.net",
          "(469) XXX-XX80"
        ]
      }
    ],
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}

Reset a User's Password

Reset a User's Password
PATCH/users/password

Example URI

PATCH /users/password
Request
HideShow
Body
{
  "email": "[email protected]",
  "token": "a",
  "password": "123456",
  "terminate_sessions": false
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.393703,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": false,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "Here is my great signature",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}
Request
HideShow
Body
{
  "email": "[email protected]",
  "shadow_token": "206cc0a36c8ecfa37639a4d0dc682c73",
  "password": "123456"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.393703,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": false,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "Here is my great signature",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}
Request
HideShow
Body
{
  "phone_number": "+4368120265807",
  "shadow_token": "206cc0a36c8ecfa37639a4d0dc682c73",
  "password": "123456"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "updated first name",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163668.393703,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": true,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": "Here is my great signature",
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "updated first name Test",
    "abbreviated_display_name": "updated first name",
    "online_state": "Offline",
    "has_password": true
  }
}

Verify Email

Verify Email
PATCH/users/email_confirmed

Example URI

PATCH /users/email_confirmed
Request
HideShow
Body
{
  "email": "[email protected]",
  "email_code": "a"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "Unit",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163673.230561,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": true,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": null,
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "Unit Test",
    "abbreviated_display_name": "Unit",
    "online_state": "Offline",
    "has_password": true
  }
}

Verify Phone Number

Verify Phone Number
PATCH/users/phone_confirmed

Example URI

PATCH /users/phone_confirmed
Request
HideShow
Body
{
  "phone_number": "+4368120265807",
  "code": "12345"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "type": "user",
    "username": null,
    "first_name": "Unit",
    "last_name": "Test",
    "email": "[email protected]",
    "phone_number": "+4368120265807",
    "created_at": 1493115498.770362,
    "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "address_id": null,
    "cover_image_url": null,
    "profile_image_url": null,
    "updated_at": 1765163673.046424,
    "user_status": "Active",
    "profile_image_thumbnail_url": null,
    "cover_image_thumbnail_url": null,
    "email_confirmed": true,
    "timezone": "America/Chicago",
    "user_type": "Admin",
    "deleted_at": null,
    "phone_confirmed": true,
    "is_shadow": false,
    "personal_room": null,
    "brand": null,
    "fake_email": false,
    "features": [
      "Deals"
    ],
    "last_seen_at": null,
    "email_signature": null,
    "daily_enabled": false,
    "email_quota": 30000,
    "website": null,
    "instagram": null,
    "twitter": null,
    "linkedin": null,
    "youtube": null,
    "facebook": null,
    "designation": null,
    "tiktok": null,
    "mfa_enabled": false,
    "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "current_time": "9:14 PM - Sunday Dec 07, 2025",
    "push_allowed": true,
    "agents": null,
    "last_seen_type": null,
    "active_brand": null,
    "display_name": "Unit Test",
    "abbreviated_display_name": "Unit",
    "online_state": "Offline",
    "has_password": true
  }
}

Add activity

Add activity
POST/users/self/timeline

Example URI

POST /users/self/timeline
Request
HideShow
Body
{
  "action": "UserOpenedIOSApp",
  "object_class": "ios_app",
  "object": {
    "type": "ios_app",
    "version": "0.0.0"
  }
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "af4991ac-b2d1-4f70-84b0-8854202fc6d2",
    "reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "reference_type": "User",
    "created_at": 1765163669.321359,
    "updated_at": 1765163669.321359,
    "deleted_at": null,
    "object": {
      "type": "ios_app",
      "version": "0.0.0"
    },
    "action": "UserOpenedIOSApp",
    "is_visible": true,
    "brand": null,
    "created_by": null,
    "description": null,
    "type": "activity"
  }
}

Update user settings

Update user settings
PUT/users/self/settings/:key

Example URI

PUT /users/self/settings/:key
URI Parameters
HideShow
key
string (required) Example: user_filter
Request
HideShow
Body
{
  "value": [
    "4926132e-9e1d-11e7-8fd6-0242ac110003",
    "5d66ae5e-f82c-11e5-b4b4-f23c91b0d077"
  ]
}
Response  200
HideShow
Body
[
  {
    "key": "user_filter",
    "value": [
      "4926132e-9e1d-11e7-8fd6-0242ac110003",
      "5d66ae5e-f82c-11e5-b4b4-f23c91b0d077"
    ]
  }
]

Upload Email Signature Attachments

Upload Email Signature Attachments
POST/users/self/email_signature_attachments

Example URI

POST /users/self/email_signature_attachments
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "31908e81-c78b-4ef5-bc69-d2dd62d9a2d0",
    "created_at": 1765163670.41081,
    "updated_at": 1765163670.41081,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "path": "80a227b2-29a0-11e7-b636-e4a7a08e15d4/signatures/02f48970-d3e4-11f0-a2d4-1bcac3894d4e.jpg",
    "name": "sample.jpg",
    "public": true,
    "type": "file",
    "url": "https://test.cloudfront.net/80a227b2-29a0-11e7-b636-e4a7a08e15d4/signatures/02f48970-d3e4-11f0-a2d4-1bcac3894d4e.jpg",
    "preview_url": "https://test.cloudfront.net/80a227b2-29a0-11e7-b636-e4a7a08e15d4/signatures/02f48970-d3e4-11f0-a2d4-1bcac3894d4e.jpg",
    "mime": "image/jpeg"
  }
}

Generated by aglio on 08 Dec 2025