API Documentation
Room ¶
Overview
A Room is basically a place where any number of rechat users (> 1) could chat.
Although the Room is basically a chat room, some other objects could be attached to it. Other concepts of Rechat like Alerts and recommendations are heavily linked to rooms.
It is important to remember that even a private discussion between two people happens on a chat room.
Get a user's Rooms ¶
Get a user's RoomsGET/rooms
Example URI
GET /rooms
URI Parameters
- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": [
{
"type": "room",
"id": "e2643c53-7b6d-4713-add6-58e3882924a9",
"title": null,
"owner": null,
"created_at": 1770151216.887092,
"updated_at": 1770151216.912537,
"deleted_at": null,
"room_type": "Direct",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "063c7d48-f7db-4c86-ac56-20268684541b",
"id": "063c7d48-f7db-4c86-ac56-20268684541b",
"comment": "Unit invited [email protected] to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1770151216.912537,
"updated_at": 1770151216.912537,
"room": "e2643c53-7b6d-4713-add6-58e3882924a9",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "219d818d-fac0-4938-8cbe-864328c70a53",
"object": "e2643c53-7b6d-4713-add6-58e3882924a9",
"message": "Unit invited [email protected] to join.",
"created_at": 1770151216.905163,
"updated_at": 1770151216.905164,
"room": "e2643c53-7b6d-4713-add6-58e3882924a9",
"action": "Invited",
"object_class": "Room",
"subject": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1770151216.843437,
"id": "16d2e454-21d9-41e9-b296-9bc7df73928c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.843451,
"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": true,
"personal_room": "e1de7d5f-2f43-4ddb-a5a9-b31faa5845cd",
"brand": null,
"fake_email": null,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
},
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1770151216.843437,
"id": "16d2e454-21d9-41e9-b296-9bc7df73928c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.843451,
"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": true,
"personal_room": "e1de7d5f-2f43-4ddb-a5a9-b31faa5845cd",
"brand": null,
"fake_email": null,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected]"
},
{
"type": "room",
"id": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"title": "sampleroom",
"owner": {
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
"created_at": 1770151216.500445,
"updated_at": 1770151216.66938,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "ff3ffb25-d57b-4f1f-97d9-5e9ad3ac77c3",
"id": "ff3ffb25-d57b-4f1f-97d9-5e9ad3ac77c3",
"comment": "Unit invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1770151216.66938,
"updated_at": 1770151216.66938,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "7d4e8e0b-64ac-4870-bbc8-00d6f49568ae",
"object": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"message": "Unit invited +18598161689 to join.",
"created_at": 1770151216.661469,
"updated_at": 1770151216.66147,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"action": "Invited",
"object_class": "Room",
"subject": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "3aa3328a-c26a-444b-a62a-130f0d190960",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-02-03T20:40:16.782586+00:00"
}
]
},
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1770151216.410549,
"id": "b9598dd5-0e83-46da-b934-5a85adb8d5f9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.410563,
"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": true,
"personal_room": "423154c1-3a32-4257-83f5-e66837ed7468",
"brand": null,
"fake_email": null,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
],
"info": {
"count": 2,
"total": 2,
"new": 0
}
}Create Room ¶
Create RoomPOST/rooms
Example URI
POST /rooms
URI Parameters
- associations
string(required) Example: room.owner,room.latest_message,room.users
Request
Body
{
"title": "sampleroom",
"room_type": "Group",
"phone_numbers": [
"+18598161689"
],
"emails": [
"[email protected]"
],
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"users": [
{
"user_id": "b9598dd5-0e83-46da-b934-5a85adb8d5f9"
},
{
"user_id": "3aa3328a-c26a-444b-a62a-130f0d190960"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"title": "sampleroom",
"owner": {
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
"created_at": 1770151216.500445,
"updated_at": 1770151216.66938,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "ff3ffb25-d57b-4f1f-97d9-5e9ad3ac77c3",
"id": "ff3ffb25-d57b-4f1f-97d9-5e9ad3ac77c3",
"comment": "Unit invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1770151216.66938,
"updated_at": 1770151216.66938,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "7d4e8e0b-64ac-4870-bbc8-00d6f49568ae",
"object": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"message": "Unit invited +18598161689 to join.",
"created_at": 1770151216.661469,
"updated_at": 1770151216.66147,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"action": "Invited",
"object_class": "Room",
"subject": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "3aa3328a-c26a-444b-a62a-130f0d190960",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-02-03T20:40:16.782586+00:00"
}
]
},
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1770151216.410549,
"id": "b9598dd5-0e83-46da-b934-5a85adb8d5f9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.410563,
"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": true,
"personal_room": "423154c1-3a32-4257-83f5-e66837ed7468",
"brand": null,
"fake_email": null,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
}Get Room ¶
Get RoomGET/rooms/{id}
Example URI
GET /rooms/148f1163-ceb1-4bdd-ab6f-4022664bb0a7
URI Parameters
- id
string(required) Example: 148f1163-ceb1-4bdd-ab6f-4022664bb0a7- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"title": "sampleroom",
"owner": {
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
"created_at": 1770151216.500445,
"updated_at": 1770151216.66938,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "ff3ffb25-d57b-4f1f-97d9-5e9ad3ac77c3",
"id": "ff3ffb25-d57b-4f1f-97d9-5e9ad3ac77c3",
"comment": "Unit invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1770151216.66938,
"updated_at": 1770151216.66938,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "7d4e8e0b-64ac-4870-bbc8-00d6f49568ae",
"object": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"message": "Unit invited +18598161689 to join.",
"created_at": 1770151216.661469,
"updated_at": 1770151216.66147,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"action": "Invited",
"object_class": "Room",
"subject": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "3aa3328a-c26a-444b-a62a-130f0d190960",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-02-03T20:40:16.782586+00:00"
}
]
},
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1770151216.410549,
"id": "b9598dd5-0e83-46da-b934-5a85adb8d5f9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.410563,
"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": true,
"personal_room": "423154c1-3a32-4257-83f5-e66837ed7468",
"brand": null,
"fake_email": null,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
}Add Users to a room ¶
Add Users to a roomPOST/rooms/{id}/users
You can add multiple users to a room in the same call
Example URI
POST /rooms/148f1163-ceb1-4bdd-ab6f-4022664bb0a7/users
URI Parameters
- id
string(required) Example: 148f1163-ceb1-4bdd-ab6f-4022664bb0a7- associations
string(required) Example: room.owner,room.latest_message,room.users
Request
Body
{
"users": [
"2dacc0a9-9cee-4ba6-8e6c-3879d12ffcf4"
]
}Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"title": "sampleroom",
"owner": {
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
"created_at": 1770151216.500445,
"updated_at": 1770151217.275038,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "eb234621-e35a-4107-9d81-474135878353",
"id": "eb234621-e35a-4107-9d81-474135878353",
"comment": "Unit invited John to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1770151217.275038,
"updated_at": 1770151217.275038,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "546bbe28-fb63-4e90-8829-d414970c04e9",
"object": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"message": "Unit invited John to join.",
"created_at": 1770151217.264277,
"updated_at": 1770151217.264277,
"room": "148f1163-ceb1-4bdd-ab6f-4022664bb0a7",
"action": "Invited",
"object_class": "Room",
"subject": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+989124834198",
"created_at": 1770151216.306551,
"id": "2dacc0a9-9cee-4ba6-8e6c-3879d12ffcf4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.306566,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "673469e4-9e04-4f5f-8b41-2cc32404daa9",
"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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "3aa3328a-c26a-444b-a62a-130f0d190960",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-02-03T20:40:17.418007+00:00"
}
]
},
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+989124834198",
"created_at": 1770151216.306551,
"id": "2dacc0a9-9cee-4ba6-8e6c-3879d12ffcf4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.306566,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "673469e4-9e04-4f5f-8b41-2cc32404daa9",
"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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1770151216.413121,
"id": "3aa3328a-c26a-444b-a62a-130f0d190960",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.413127,
"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": true,
"personal_room": "ff1f6519-c0d0-4013-a683-dec3ddb237b8",
"brand": null,
"fake_email": true,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"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": 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": 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": "2:40 PM - Tuesday Feb 03, 2026",
"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
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1770151216.410549,
"id": "b9598dd5-0e83-46da-b934-5a85adb8d5f9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1770151216.410563,
"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": true,
"personal_room": "423154c1-3a32-4257-83f5-e66837ed7468",
"brand": null,
"fake_email": null,
"features": null,
"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": null,
"current_time": "2:40 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689, John"
}
}Remove user from a room ¶
Remove user from a roomDELETE/rooms/{rid}/users/{id}
Example URI
DELETE /rooms/148f1163-ceb1-4bdd-ab6f-4022664bb0a7/users/80a227b2-29a0-11e7-b636-e4a7a08e15d4
URI Parameters
- rid
string(required) Example: 148f1163-ceb1-4bdd-ab6f-4022664bb0a7- id
string(required) Example: 80a227b2-29a0-11e7-b636-e4a7a08e15d4
Response
204