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": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
}
Response
200
Body
{
"code": "OK",
"data": {
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20
Request
Body
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
}
Response
200
Body
{
"code": "OK",
"data": {
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20- q
string
(required) Example: User
Response
200
Body
{
"code": "OK",
"data": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20- q
string
(required) Example: User
Response
200
Body
{
"code": "OK",
"data": [
{
"id": "2a3fcba5-17ec-4ea6-a11c-1f42a781d5f9",
"user": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+14099990002",
"created_at": 1760469961.002174,
"id": "2a3fcba5-17ec-4ea6-a11c-1f42a781d5f9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": "https://test.cloudfront.net/2a3fcba5-17ec-4ea6-a11c-1f42a781d5f9/9e333e30-a933-11f0-bdea-d5cf17ea076e.jpg",
"updated_at": 1760469961.121232,
"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": "15ad0661-c63b-40ac-ac4e-4d6e7b77555c",
"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:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": "+14099990002",
"abbreviated_display_name": "+14099990002",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
}
],
"type": "user_brands"
},
{
"id": "506aa33c-078f-4da0-a286-dc8653b5d0c1",
"user": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "BBB",
"email": "[email protected]",
"phone_number": "+14099990001",
"created_at": 1760469960.892511,
"id": "506aa33c-078f-4da0-a286-dc8653b5d0c1",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760469960.892533,
"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": "cd0f2a64-1144-45e8-b233-c34708167091",
"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:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": " BBB",
"abbreviated_display_name": "+14099990001",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
}
],
"type": "user_brands"
},
{
"id": "996ec592-f960-4830-956b-f6f3c178cec4",
"user": {
"type": "user",
"username": null,
"first_name": "AAA",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1760469960.335455,
"id": "996ec592-f960-4830-956b-f6f3c178cec4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760469960.335475,
"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": "e6f08d75-4909-4202-91d5-785d5f032f8e",
"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": "2:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": "AAA ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
}
],
"type": "user_brands"
},
{
"id": "bf320f2b-cbf9-4ae9-a592-64ebb2e492d2",
"user": {
"type": "user",
"username": null,
"first_name": "AAA",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1760469960.448265,
"id": "bf320f2b-cbf9-4ae9-a592-64ebb2e492d2",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760469960.448277,
"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": "a25b05f3-7da8-4ebb-9024-0e1557bae713",
"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": "2:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": "AAA ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
}
],
"type": "user_brands"
},
{
"id": "d5bc3e21-6d57-46ef-a646-c8d1ecb08f04",
"user": {
"type": "user",
"username": null,
"first_name": "DDD",
"last_name": "EEE",
"email": "[email protected]",
"phone_number": "+14099990003",
"created_at": 1760469961.261228,
"id": "d5bc3e21-6d57-46ef-a646-c8d1ecb08f04",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760469961.261251,
"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": "76700e2f-3a5b-4709-a62f-3a3f1d3c1274",
"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": "2:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": "DDD EEE",
"abbreviated_display_name": "DDD",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
}
],
"type": "user_brands"
},
{
"id": "5ef6d43d-1f2b-4bf5-8d9f-e7774a951454",
"user": {
"type": "user",
"username": null,
"first_name": "FFF",
"last_name": "GGG",
"email": "[email protected]",
"phone_number": "+14099990004",
"created_at": 1760469961.380206,
"id": "5ef6d43d-1f2b-4bf5-8d9f-e7774a951454",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760469961.380226,
"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": "e264692d-bf31-462a-b000-22b1a3c973c1",
"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": "2:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": "FFF GGG",
"abbreviated_display_name": "FFF",
"online_state": "Offline",
"has_password": false
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
}
],
"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": 1760469958.842611,
"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": null,
"current_time": "2:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "e1f22cf0-4b69-4a45-b78d-89635c3f228d",
"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": 1760469958.936468,
"deleted_at": null,
"created_at": 1760469958.936468,
"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": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brands": [
{
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469959.947223,
"updated_at": 1760469959.947223,
"palette": {
"type": "brand_palette",
"primary": "red"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7",
"created_at": 1760469959.08568,
"updated_at": 1760469959.08568,
"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": [
"fa40c5d0-16a0-47c6-9eb6-3e443c32b7e7"
],
"type": "brand",
"hostnames": null,
"member_count": 7,
"base_url": "https://irish.rechat.com"
}
],
"brand_roles": [
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "9eaeb9f1-b6dd-4bc3-8f42-5bcbc2ba46df"
},
{
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"role": "5b405ba8-5bec-4e38-9fc9-b7db2611c834"
}
],
"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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20
Response
200
Body
{
"code": "OK",
"data": [
{
"type": "user",
"username": null,
"first_name": "AAA",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1760469960.335455,
"id": "996ec592-f960-4830-956b-f6f3c178cec4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760469960.335475,
"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": "e6f08d75-4909-4202-91d5-785d5f032f8e",
"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": "2:25 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20
Response
200
Body
{
"code": "OK",
"data": [
{
"id": "8f600947-d94b-4b71-a8a4-87a612598d5e",
"created_at": 1760469963.911562,
"updated_at": null,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"file": {
"id": "f8051b4b-ae6b-4b52-ac6b-feb537184fc8",
"created_at": 1760469963.903634,
"updated_at": 1760469963.903634,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "brands/assets/9fdd6bc0-a933-11f0-bdea-d5cf17ea076e.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/brands/assets/9fdd6bc0-a933-11f0-bdea-d5cf17ea076e.png",
"preview_url": "https://test.cloudfront.net/brands/assets/9fdd6bc0-a933-11f0-bdea-d5cf17ea076e.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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20
Response
200
Body
{
"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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df94270-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df96980-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Euclid Circular A Medium",
"font-style": "normal",
"font-weight": 500,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df99090-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9b7a0-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Euclid Circular A Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9deb0-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9deb1-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Euclid Circular A SemiBold",
"font-style": "normal",
"font-weight": 600,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa05c0-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa05c1-a933-11f0-bdea-d5cf17ea076e.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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa2cd0-a933-11f0-bdea-d5cf17ea076e.ttf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa53e0-a933-11f0-bdea-d5cf17ea076e.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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa53e1-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa7af0-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Sainte Colombe Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa7af1-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfaa200-a933-11f0-bdea-d5cf17ea076e.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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20- 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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df94270-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df96980-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Euclid Circular A Medium",
"font-style": "normal",
"font-weight": 500,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df99090-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9b7a0-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Euclid Circular A Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9deb0-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9deb1-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Euclid Circular A SemiBold",
"font-style": "normal",
"font-weight": 600,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa05c0-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa05c1-a933-11f0-bdea-d5cf17ea076e.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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa2cd0-a933-11f0-bdea-d5cf17ea076e.ttf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa53e0-a933-11f0-bdea-d5cf17ea076e.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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa53e1-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa7af0-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
},
{
"name": "Sainte Colombe Regular",
"font-style": "normal",
"font-weight": 400,
"files": [
{
"format": "opentype",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa7af1-a933-11f0-bdea-d5cf17ea076e.otf"
},
{
"format": "woff",
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfaa200-a933-11f0-bdea-d5cf17ea076e.woff"
}
]
}
]
}
]
}
}
Response
200
Body
{
"code": "OK",
"data": {
"id": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"created_at": 1760469958.842611,
"updated_at": 1760469958.842611,
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df94270-a933-11f0-bdea-d5cf17ea076e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df96980-a933-11f0-bdea-d5cf17ea076e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 300
},
{
"name": "Euclid Circular A Medium",
"files": [
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df99090-a933-11f0-bdea-d5cf17ea076e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9b7a0-a933-11f0-bdea-d5cf17ea076e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 500
},
{
"name": "Euclid Circular A Regular",
"files": [
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9deb0-a933-11f0-bdea-d5cf17ea076e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9df9deb1-a933-11f0-bdea-d5cf17ea076e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 400
},
{
"name": "Euclid Circular A SemiBold",
"files": [
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa05c0-a933-11f0-bdea-d5cf17ea076e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa05c1-a933-11f0-bdea-d5cf17ea076e.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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa2cd0-a933-11f0-bdea-d5cf17ea076e.ttf",
"format": "truetype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa53e0-a933-11f0-bdea-d5cf17ea076e.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/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa53e1-a933-11f0-bdea-d5cf17ea076e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa7af0-a933-11f0-bdea-d5cf17ea076e.woff",
"format": "woff"
}
],
"font-style": "normal",
"font-weight": 300
},
{
"name": "Sainte Colombe Regular",
"files": [
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfa7af1-a933-11f0-bdea-d5cf17ea076e.otf",
"format": "opentype"
},
{
"url": "https://test.cloudfront.net/brands/720e8b69-0ed3-497e-86d0-80fc2dfcfe20/assets/fonts/9dfaa200-a933-11f0-bdea-d5cf17ea076e.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"
}
}