API Documentation
Website ¶
Overview
Website endpoints are responsible for manipulating the data for our website builder.
Create a website ¶
Create a websitePOST/websites
Example URI
POST /websites
Request
Body
{
"template": "light",
"title": "Website Title",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"template_instance": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"brand": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
}Get a website ¶
Get a websiteGET/websites/:id
Example URI
GET /websites/:id
URI Parameters
- id
string(required) Example: c70d9eb5-4dae-4219-8338-6780783d917a
Response
200Body
{
"code": "OK",
"data": {
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
}Update a website ¶
Update a websitePUT/websites/:id
Example URI
PUT /websites/:id
URI Parameters
- id
string(required) Example: c70d9eb5-4dae-4219-8338-6780783d917a
Request
Body
{
"template": "light2",
"title": "Website Title",
"attributes": {
"biography": "Foo bar",
"facebook_url": "https://updated_facebook_url",
"new_attribute": "value"
},
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163676.081377,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light2",
"attributes": {
"biography": "Foo bar",
"facebook_url": "https://updated_facebook_url",
"new_attribute": "value"
},
"title": "Website Title",
"template_instance": null,
"hostnames": [
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
}Get all user's websites ¶
Get all user's websitesGET/websites
Example URI
GET /websites
Response
200Body
{
"code": "OK",
"data": [
{
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
],
"info": {
"count": 1,
"total": 0
}
}Get all brand's websites ¶
Get all brand's websitesGET/brand/:brand/websites
Example URI
GET /brand/:brand/websites
URI Parameters
- brand
string(required) Example: 22387611-f8a3-48c0-98bb-8cd1eb45e30a
Response
200Body
{
"code": "OK",
"data": [
{
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
],
"info": {
"count": 1,
"total": 1
}
}Add hostname to a website ¶
Add hostname to a websitePOST/websites/:id/hostnames
Example URI
POST /websites/:id/hostnames
URI Parameters
- id
string(required) Example: c70d9eb5-4dae-4219-8338-6780783d917a
Request
Body
{
"hostname": "localsite",
"is_default": true,
"website": "c70d9eb5-4dae-4219-8338-6780783d917a"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"localsite",
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
}Delete hostname from a website ¶
Delete hostname from a websiteDELETE/websites/:id/hostnames?hostname=:hostname
Example URI
DELETE /websites/:id/hostnames?hostname=:hostname
URI Parameters
- id
string(required) Example: c70d9eb5-4dae-4219-8338-6780783d917a- hostname
string(required) Example: localsite
Response
200Body
{
"code": "OK",
"data": {
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
}Delete a website ¶
Delete a websiteDELETE/websites/:id
Example URI
DELETE /websites/:id
URI Parameters
- id
string(required) Example: c70d9eb5-4dae-4219-8338-6780783d917a
Request
Body
{
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
204Find a website by its hostname ¶
Find a website by its hostnameGET/websites/search?hostname=:hostname
Example URI
GET /websites/search?hostname=:hostname
URI Parameters
- hostname
string(required) Example: localsite
Response
200Body
{
"code": "OK",
"data": {
"id": "c70d9eb5-4dae-4219-8338-6780783d917a",
"type": "website",
"created_at": 1765163675.677803,
"updated_at": 1765163675.678081,
"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": 1765163673.519384,
"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:14 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "49cbb6bb-5e04-4b55-881e-034b3f2affb1",
"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": 1765163673.621039,
"deleted_at": null,
"created_at": 1765163673.621039,
"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": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"brand": {
"id": "22387611-f8a3-48c0-98bb-8cd1eb45e30a",
"created_at": 1765163674.505906,
"updated_at": 1765163674.505906,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "6b50a60c-c5a8-458e-a485-dc84b07028de",
"created_at": 1765163674.462659,
"updated_at": 1765163674.462659,
"palette": {
"primary": "red",
"type": "brand_palette"
},
"assets": {
"type": "brand_assets"
},
"messages": {
"type": "brand_messages"
},
"parent": {
"id": "a4871201-cc0f-444b-b0c0-57e9aad95741",
"created_at": 1765163673.73716,
"updated_at": 1765163673.73716,
"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": "Parent Brand",
"deleted_at": null,
"training": false,
"brand_type": "Brokerage",
"parents": [
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"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": [
"6b50a60c-c5a8-458e-a485-dc84b07028de",
"a4871201-cc0f-444b-b0c0-57e9aad95741"
],
"type": "brand",
"hostnames": null,
"member_count": 1,
"base_url": "https://irish.rechat.com"
},
"template": "light",
"attributes": {
"biography": "Foo bar",
"facebook_url": "http://facebook.com/foo"
},
"title": "Website Title",
"template_instance": {
"id": "40be0b7d-81f5-4aff-bd6e-d54420501a37",
"created_at": 1765163673.519384,
"html": "SOME HTML",
"file": {
"id": "a68465d5-6e14-4d5d-ab67-b0ec3da64355",
"created_at": 1765163675.607713,
"updated_at": 1765163675.607713,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/templates/instances/060d8940-d3e4-11f0-a2d4-1bcac3894d4e.png",
"mime": "image/png"
},
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"branch": "http://mock-branch-url",
"updated_at": 1765163673.519384,
"deleted_at": null,
"type": "template_instance"
},
"hostnames": [
"localsite",
"serene-mirzakhani.undefined"
],
"wid": "c70d9eb5-4dae-4219-8338-6780783d917a",
"ord": "1"
}
}