API Documentation
Brands ¶
Create new brand ¶
Create new brandPOST/brands
Example URI
POST /brands
Request
Body
{
"brand_type": "Brokerage",
"palette": {
"primary": "red"
},
"assets": {},
"messages": {},
"name": "Child Brand",
"roles": [
{
"role": "Owner",
"members": [
{
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
],
"acl": [
"Admin",
"Marketing",
"Deals",
"CRM",
"Showings"
]
}
],
"parent": "bb55d06a-1932-4be5-8c1a-5d48d35e8561"
}Response
200Body
{
"code": "OK",
"data": {
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Child Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
}
}Update a brand ¶
Update a brandPUT/brands/:id
Example URI
PUT /brands/:id
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70
Request
Body
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
}Response
200Body
{
"code": "OK",
"data": {
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
}
}Users ¶
Get agents of a brand ¶
Get agents of a brandGET/brands/:brand/agents
Example URI
GET /brands/:brand/agents
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70- q
string(required) Example: User
Response
200Body
{
"code": "OK",
"data": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"info": {
"count": 1,
"total": 0
}
}Get users of a brand ¶
Get users of a brandGET/brands/:brand/users
Example URI
GET /brands/:brand/users
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70- q
string(required) Example: User
Response
200Body
{
"code": "OK",
"data": [
{
"id": "e5ed459f-22ba-4c55-a5a2-c75459d602de",
"user": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+14099990002",
"created_at": 1765163416.921112,
"id": "e5ed459f-22ba-4c55-a5a2-c75459d602de",
"address_id": null,
"cover_image_url": null,
"profile_image_url": "https://test.cloudfront.net/e5ed459f-22ba-4c55-a5a2-c75459d602de/6be8ef30-d3e3-11f0-a2d4-1bcac3894d4e.jpg",
"updated_at": 1765163417.013266,
"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": "9ae87a95-4fd2-41df-986c-c2289babe39c",
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "+14099990002",
"abbreviated_display_name": "+14099990002",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
}
],
"type": "user_brands"
},
{
"id": "d202b917-7458-4eee-9d22-ef24d36ecd7b",
"user": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "BBB",
"email": "[email protected]",
"phone_number": "+14099990001",
"created_at": 1765163416.751087,
"id": "d202b917-7458-4eee-9d22-ef24d36ecd7b",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1765163416.751114,
"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": "0ebbc91b-51f3-4604-a7e3-7ef632ecbe3d",
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": " BBB",
"abbreviated_display_name": "+14099990001",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
}
],
"type": "user_brands"
},
{
"id": "85eed07d-d4d9-44e6-8b15-6fd66351a6af",
"user": {
"type": "user",
"username": null,
"first_name": "AAA",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1765163416.321377,
"id": "85eed07d-d4d9-44e6-8b15-6fd66351a6af",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1765163416.321405,
"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": "7753e6b4-f31d-407d-beb0-dd9f58ccd13e",
"brand": null,
"fake_email": false,
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "AAA ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
}
],
"type": "user_brands"
},
{
"id": "29208677-a8d6-421c-bb9c-2894b0634fbf",
"user": {
"type": "user",
"username": null,
"first_name": "AAA",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1765163416.188132,
"id": "29208677-a8d6-421c-bb9c-2894b0634fbf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1765163416.188158,
"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": "8eec33db-ff0e-40fe-bf86-7a23d0b2b7ad",
"brand": null,
"fake_email": false,
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "AAA ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
}
],
"type": "user_brands"
},
{
"id": "ba1388a4-6e2c-4de5-9291-d6a2c7a3b9bf",
"user": {
"type": "user",
"username": null,
"first_name": "DDD",
"last_name": "EEE",
"email": "[email protected]",
"phone_number": "+14099990003",
"created_at": 1765163417.157955,
"id": "ba1388a4-6e2c-4de5-9291-d6a2c7a3b9bf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1765163417.157982,
"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": "08d2447c-818f-4eae-a186-da2affa37750",
"brand": null,
"fake_email": false,
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "DDD EEE",
"abbreviated_display_name": "DDD",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
}
],
"type": "user_brands"
},
{
"id": "b1cd1cd9-24b5-476b-ab83-d471c9371f8a",
"user": {
"type": "user",
"username": null,
"first_name": "FFF",
"last_name": "GGG",
"email": "[email protected]",
"phone_number": "+14099990004",
"created_at": 1765163417.344603,
"id": "b1cd1cd9-24b5-476b-ab83-d471c9371f8a",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1765163417.344628,
"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": "302b60c6-7e64-4818-a2c4-3be2e8a4b2b2",
"brand": null,
"fake_email": false,
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "FFF GGG",
"abbreviated_display_name": "FFF",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
}
],
"type": "user_brands"
},
{
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"user": {
"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": 1765163414.626271,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "7a27354d-a39b-4cc4-9f28-3bdc44a7a147",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1765163414.744305,
"deleted_at": null,
"created_at": 1765163414.744305,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brands": [
{
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163415.776898,
"updated_at": 1765163415.776898,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "bb55d06a-1932-4be5-8c1a-5d48d35e8561",
"created_at": 1765163414.910148,
"updated_at": 1765163414.910148,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": null,
"name": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": null,
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"name": "Updated Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"bb55d06a-1932-4be5-8c1a-5d48d35e8561"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "7e85e430-1919-495c-9b0f-08c539779924"
},
{
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"role": "a1931cea-bb3f-4b25-b7af-6df6ad92c366"
}
],
"type": "user_brands"
}
],
"info": {
"count": 7,
"total": 0
}
}Add a member with multi roles ¶
Add a member with multi rolesPOST/brands/:brand/members
brand (uuid) ID of the brand
email (string) email of user
first_name (string) first name of user
last_name (string) last name of user
avatar (file) file
phone_number (string) phone number
roles (string) it should be stringified of an json array
Example URI
POST /brands/:brand/members
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70
Response
200Body
{
"code": "OK",
"data": [
{
"type": "user",
"username": null,
"first_name": "AAA",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1765163416.188132,
"id": "29208677-a8d6-421c-bb9c-2894b0634fbf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1765163416.188158,
"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": "8eec33db-ff0e-40fe-bf86-7a23d0b2b7ad",
"brand": null,
"fake_email": false,
"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": "9:10 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"display_name": "AAA ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"info": {
"count": 1,
"total": 0
}
}Assets ¶
Get assets of brand ¶
Get assets of brandGET/brands/:brand/assets
brand (uuid) ID of the brand
mediums (Array) Applicable mediums (optional)
template_types (Array) Applicable template types (optional)
labels (Array) labels template types
Example URI
GET /brands/:brand/assets
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70
Response
200Body
{
"code": "OK",
"data": [
{
"id": "e6022f2c-19bc-4020-adc8-c063ea34dc20",
"created_at": 1765163422.341531,
"updated_at": null,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"file": {
"id": "d707881b-4bf6-4b39-a6ac-ed87ffbbd45e",
"created_at": 1765163422.327865,
"updated_at": 1765163422.327865,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "brands/assets/6f161340-d3e3-11f0-a2d4-1bcac3894d4e.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/brands/assets/6f161340-d3e3-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/brands/assets/6f161340-d3e3-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"label": "Asset Label",
"template_type": "Christmas",
"medium": "Email",
"branch": null,
"type": "brand_asset"
}
],
"info": {
"count": 1,
"total": 0
}
}Settings ¶
Upload fonts ¶
Upload fontsPOST/brands/:brand/settings/fonts
With this API you can upload multi fonts with format: ttf | otf | woff | woff2 | svg | svgz | eot | otc | ttc
Example URI
POST /brands/:brand/settings/fonts
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70
Response
200Body
{
"code": "OK",
"data": [
{
"name": "Euclid Circular A",
"source": "file",
"variants": [
{
"name": "Euclid Circular A Light",
"font-style": "normal",
"font-weight": 300,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baa5f90-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baa86a0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Euclid Circular A Medium",
"font-style": "normal",
"font-weight": 500,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baaadb0-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baad4c0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Euclid Circular A Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baad4c1-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baafbd0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Euclid Circular A SemiBold",
"font-style": "normal",
"font-weight": 600,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baafbd1-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab22e0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
}
]
},
{
"name": "NewsGoth Cn BT",
"source": "file",
"variants": [
{
"name": "NewsGoth Cn BT Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "truetype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab22e1-d3e3-11f0-a2d4-1bcac3894d4e.ttf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab49f0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
}
]
},
{
"name": "Sainte Colombe",
"source": "file",
"variants": [
{
"name": "Sainte Colombe Light",
"font-style": "normal",
"font-weight": 300,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab7100-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab7101-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Sainte Colombe Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab9810-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab9811-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
}
]
}
]
}Upload fonts ¶
Upload fontsPUT/brands/:brand/settings/:key
You can save the setting with this API. here is an example to save a marketingPallete with fonts
Example URI
PUT /brands/:brand/settings/:key
URI Parameters
- id
string(required) Example: d0334b44-83ed-4771-a5e1-18f2edffdc70- key
string(required) Example: marketing_palette
Request
Body
{
"value": {
"body-bg-color": "#eee",
"fonts": [
{
"name": "Euclid Circular A",
"source": "file",
"variants": [
{
"name": "Euclid Circular A Light",
"font-style": "normal",
"font-weight": 300,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baa5f90-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baa86a0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Euclid Circular A Medium",
"font-style": "normal",
"font-weight": 500,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baaadb0-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baad4c0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Euclid Circular A Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baad4c1-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baafbd0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Euclid Circular A SemiBold",
"font-style": "normal",
"font-weight": 600,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baafbd1-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab22e0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
}
]
},
{
"name": "NewsGoth Cn BT",
"source": "file",
"variants": [
{
"name": "NewsGoth Cn BT Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "truetype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab22e1-d3e3-11f0-a2d4-1bcac3894d4e.ttf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab49f0-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
}
]
},
{
"name": "Sainte Colombe",
"source": "file",
"variants": [
{
"name": "Sainte Colombe Light",
"font-style": "normal",
"font-weight": 300,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab7100-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab7101-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
},
{
"name": "Sainte Colombe Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab9810-d3e3-11f0-a2d4-1bcac3894d4e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab9811-d3e3-11f0-a2d4-1bcac3894d4e.woff"
}
]
}
]
}
]
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"created_at": 1765163414.626271,
"updated_at": 1765163414.626271,
"brand": "d0334b44-83ed-4771-a5e1-18f2edffdc70",
"marketing_palette": {
"type": "marketing_palette",
"fonts": [
{
"name": "Euclid Circular A",
"source": "file",
"variants": [
{
"name": "Euclid Circular A Light",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baa5f90-d3e3-11f0-a2d4-1bcac3894d4e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baa86a0-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 300
},
{
"name": "Euclid Circular A Medium",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baaadb0-d3e3-11f0-a2d4-1bcac3894d4e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baad4c0-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 500
},
{
"name": "Euclid Circular A Regular",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baad4c1-d3e3-11f0-a2d4-1bcac3894d4e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baafbd0-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 400
},
{
"name": "Euclid Circular A SemiBold",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6baafbd1-d3e3-11f0-a2d4-1bcac3894d4e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab22e0-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 600
}
]
},
{
"name": "NewsGoth Cn BT",
"source": "file",
"variants": [
{
"name": "NewsGoth Cn BT Regular",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab22e1-d3e3-11f0-a2d4-1bcac3894d4e.ttf",
"format": "truetype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab49f0-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 400
}
]
},
{
"name": "Sainte Colombe",
"source": "file",
"variants": [
{
"name": "Sainte Colombe Light",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab7100-d3e3-11f0-a2d4-1bcac3894d4e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab7101-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 300
},
{
"name": "Sainte Colombe Regular",
"files": [
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab9810-d3e3-11f0-a2d4-1bcac3894d4e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/d0334b44-83ed-4771-a5e1-18f2edffdc70/assets/fonts/6bab9811-d3e3-11f0-a2d4-1bcac3894d4e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 400
}
]
}
],
"body-bg-color": "#eee"
},
"theme": {
"type": "theme",
"navbar": {
"logo": {},
"button": {},
"background": {}
},
"palette": {
"info": {},
"text": {},
"error": {},
"common": {},
"primary": {},
"success": {},
"warning": {},
"secondary": {},
"background": {}
}
},
"websites_root_domain": null,
"help_center": null,
"type": "brand_settings"
}
}