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": "0f3e586a-ed65-44af-94b3-cef2d23a78ea",
"title": null,
"owner": null,
"created_at": 1787792173.815881,
"updated_at": 1787792173.86143,
"deleted_at": null,
"room_type": "Direct",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "608ad09a-df95-4d3c-8977-73904d032a1d",
"id": "608ad09a-df95-4d3c-8977-73904d032a1d",
"comment": "John invited [email protected] to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1787792173.86143,
"updated_at": 1787792173.86143,
"room": "0f3e586a-ed65-44af-94b3-cef2d23a78ea",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "117d56ec-3052-4a43-bed6-c40325ecb8c5",
"object": "0f3e586a-ed65-44af-94b3-cef2d23a78ea",
"message": "John invited [email protected] to join.",
"created_at": 1787792173.849543,
"updated_at": 1787792173.849543,
"room": "0f3e586a-ed65-44af-94b3-cef2d23a78ea",
"action": "Invited",
"object_class": "Room",
"subject": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1787792173.779847,
"id": "22a0fe65-78fa-4003-8671-28e86a625251",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.77986,
"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": "4123e533-62e7-40d5-8fa4-841ce6ce5522",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
}
]
},
"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,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
},
"notification_settings": {
"82f52e5c-daac-4bae-8b1b-efa5e9b40932": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1787792173.779847,
"id": "22a0fe65-78fa-4003-8671-28e86a625251",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.77986,
"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": "4123e533-62e7-40d5-8fa4-841ce6ce5522",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected]"
},
{
"type": "room",
"id": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
},
"created_at": 1787792173.398248,
"updated_at": 1787792173.567594,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "1fcf9d28-f0c4-4a0e-804a-4ff65d350eb3",
"id": "1fcf9d28-f0c4-4a0e-804a-4ff65d350eb3",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1787792173.567594,
"updated_at": 1787792173.567594,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "c745a3bd-4a00-4bf1-b01a-7425ca295265",
"object": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"message": "John invited +18598161689 to join.",
"created_at": 1787792173.557816,
"updated_at": 1787792173.557816,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"action": "Invited",
"object_class": "Room",
"subject": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
}
]
},
"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,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-08-27T00:56:13.684122+00:00"
}
]
},
"notification_settings": {
"82f52e5c-daac-4bae-8b1b-efa5e9b40932": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1787792173.361787,
"id": "d71c7942-34c2-4c49-b91b-4a76c1bace58",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.361801,
"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": "1415a170-3491-4e31-b2ed-8e76ef0c5738",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"users": [
{
"user_id": "d71c7942-34c2-4c49-b91b-4a76c1bace58"
},
{
"user_id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
},
"created_at": 1787792173.398248,
"updated_at": 1787792173.567594,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "1fcf9d28-f0c4-4a0e-804a-4ff65d350eb3",
"id": "1fcf9d28-f0c4-4a0e-804a-4ff65d350eb3",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1787792173.567594,
"updated_at": 1787792173.567594,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "c745a3bd-4a00-4bf1-b01a-7425ca295265",
"object": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"message": "John invited +18598161689 to join.",
"created_at": 1787792173.557816,
"updated_at": 1787792173.557816,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"action": "Invited",
"object_class": "Room",
"subject": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
}
]
},
"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,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-08-27T00:56:13.684122+00:00"
}
]
},
"notification_settings": {
"82f52e5c-daac-4bae-8b1b-efa5e9b40932": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1787792173.361787,
"id": "d71c7942-34c2-4c49-b91b-4a76c1bace58",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.361801,
"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": "1415a170-3491-4e31-b2ed-8e76ef0c5738",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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/1654ca26-32ac-4130-a0cb-c470edca4c6c
URI Parameters
- id
string(required) Example: 1654ca26-32ac-4130-a0cb-c470edca4c6c- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
},
"created_at": 1787792173.398248,
"updated_at": 1787792173.567594,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "1fcf9d28-f0c4-4a0e-804a-4ff65d350eb3",
"id": "1fcf9d28-f0c4-4a0e-804a-4ff65d350eb3",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1787792173.567594,
"updated_at": 1787792173.567594,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "c745a3bd-4a00-4bf1-b01a-7425ca295265",
"object": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"message": "John invited +18598161689 to join.",
"created_at": 1787792173.557816,
"updated_at": 1787792173.557816,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"action": "Invited",
"object_class": "Room",
"subject": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
}
]
},
"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,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-08-27T00:56:13.684122+00:00"
}
]
},
"notification_settings": {
"82f52e5c-daac-4bae-8b1b-efa5e9b40932": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1787792173.361787,
"id": "d71c7942-34c2-4c49-b91b-4a76c1bace58",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.361801,
"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": "1415a170-3491-4e31-b2ed-8e76ef0c5738",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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/1654ca26-32ac-4130-a0cb-c470edca4c6c/users
URI Parameters
- id
string(required) Example: 1654ca26-32ac-4130-a0cb-c470edca4c6c- associations
string(required) Example: room.owner,room.latest_message,room.users
Request
Body
{
"users": [
"64979505-9c31-4700-922a-95e184801941"
]
}Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
},
"created_at": 1787792173.398248,
"updated_at": 1787792174.501002,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "0ea373c4-9ae8-42db-a634-6e200db73cae",
"id": "0ea373c4-9ae8-42db-a634-6e200db73cae",
"comment": "John invited John to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1787792174.501002,
"updated_at": 1787792174.501002,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "0eec8dd0-7deb-4ebd-bde0-7486a35bb24b",
"object": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"message": "John invited John to join.",
"created_at": 1787792174.486776,
"updated_at": 1787792174.486776,
"room": "1654ca26-32ac-4130-a0cb-c470edca4c6c",
"action": "Invited",
"object_class": "Room",
"subject": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+989124834198",
"created_at": 1787792173.274917,
"id": "64979505-9c31-4700-922a-95e184801941",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.274931,
"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": "b2e8391e-7ba2-491a-926e-697cdb467c4e",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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
}
]
},
"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,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-08-27T00:56:14.683194+00:00"
}
]
},
"notification_settings": {
"82f52e5c-daac-4bae-8b1b-efa5e9b40932": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+989124834198",
"created_at": 1787792173.274917,
"id": "64979505-9c31-4700-922a-95e184801941",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.274931,
"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": "b2e8391e-7ba2-491a-926e-697cdb467c4e",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16237318196",
"created_at": 1787792173.080996,
"id": "82f52e5c-daac-4bae-8b1b-efa5e9b40932",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.081012,
"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": "14bfc601-5a20-450d-b5a0-db4e680dcadf",
"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,
"bio": "This is my bio.",
"current_time": "7:56 PM - Wednesday Aug 26, 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": 1787792173.363078,
"id": "c6f4b17f-aaec-4e5d-aaf2-c0d11dbad1b0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.363091,
"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": "7853479c-ead7-4013-8b23-6669e6625ecc",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1787792173.361787,
"id": "d71c7942-34c2-4c49-b91b-4a76c1bace58",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787792173.361801,
"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": "1415a170-3491-4e31-b2ed-8e76ef0c5738",
"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,
"bio": null,
"current_time": "7:56 PM - Wednesday Aug 26, 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/1654ca26-32ac-4130-a0cb-c470edca4c6c/users/82f52e5c-daac-4bae-8b1b-efa5e9b40932
URI Parameters
- rid
string(required) Example: 1654ca26-32ac-4130-a0cb-c470edca4c6c- id
string(required) Example: 82f52e5c-daac-4bae-8b1b-efa5e9b40932
Response
204