Back to top

API Documentation

Website

Overview

Website endpoints are responsible for manipulating the data for our website builder.

Create a website

Create a website
POST/websites

Example URI

POST /websites
Request
HideShow
Body
{
  "template": "light",
  "title": "Website Title",
  "attributes": {
    "biography": "Foo bar",
    "facebook_url": "http://facebook.com/foo"
  },
  "template_instance": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
  "brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
  "user": "cb24db9a-ba25-424e-8697-2be40f11c71e",
  "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "type": "website",
    "created_at": 1791559331.000551,
    "updated_at": 1791559331.000772,
    "user": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+14345711523",
      "created_at": 1791559330.300144,
      "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791559330.292516,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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,
      "bio": "This is my bio.",
      "current_time": "10:22 AM - Friday Oct 09, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
          "email": "[email protected]",
          "mlsid": "00920130",
          "fax": "(972) 264-4703",
          "full_name": "Gholi Sweet",
          "first_name": "Gholi",
          "last_name": "Sweet",
          "middle_name": null,
          "phone_number": "+19722644703",
          "nar_number": "797500044",
          "office_mui": "15512742",
          "status": "Active",
          "office_mlsid": "RCHT01X",
          "work_phone": "+14693588080",
          "generational_name": null,
          "matrix_unique_id": "775233133",
          "updated_at": 1791559330.356224,
          "deleted_at": null,
          "created_at": 1791559330.356224,
          "mls": "NTREIS",
          "license_number": null,
          "designation": null,
          "nrds": "01053140",
          "type": "agent",
          "office_id": null,
          "secret_questions": [
            "(972) XXX-XX03",
            "jewellxxxxxxxxxxxxxal.net",
            "+1XXXXXXXX80"
          ]
        }
      ],
      "last_seen_type": null,
      "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "created_at": 1791559330.566206,
      "updated_at": 1791559330.566206,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
        "created_at": 1791559330.423046,
        "updated_at": 1791559330.423046,
        "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": [
        "bfc98f80-25ed-4539-a272-f431e29d9802"
      ],
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
    "template": "light",
    "attributes": {
      "biography": "Foo bar",
      "facebook_url": "http://facebook.com/foo"
    },
    "title": "Website Title",
    "template_instance": {
      "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
      "created_at": 1791559330.292516,
      "html": "SOME HTML",
      "file": {
        "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
        "created_at": 1791559330.959366,
        "updated_at": 1791559330.959366,
        "deleted_at": null,
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "mime": "image/png"
      },
      "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "branch": "http://mock-branch-url",
      "updated_at": 1791559330.292516,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "gracious-gould.rechat.site"
    ],
    "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "ord": "1"
  }
}

Get a website

Get a website
GET/websites/:id

Example URI

GET /websites/:id
URI Parameters
HideShow
id
string (required) Example: 3a81e80f-4dac-45ef-ab95-d147379789d1
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "type": "website",
    "created_at": 1791559331.000551,
    "updated_at": 1791559331.000772,
    "user": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+14345711523",
      "created_at": 1791559330.300144,
      "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791559330.292516,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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,
      "bio": "This is my bio.",
      "current_time": "10:22 AM - Friday Oct 09, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
          "email": "[email protected]",
          "mlsid": "00920130",
          "fax": "(972) 264-4703",
          "full_name": "Gholi Sweet",
          "first_name": "Gholi",
          "last_name": "Sweet",
          "middle_name": null,
          "phone_number": "+19722644703",
          "nar_number": "797500044",
          "office_mui": "15512742",
          "status": "Active",
          "office_mlsid": "RCHT01X",
          "work_phone": "+14693588080",
          "generational_name": null,
          "matrix_unique_id": "775233133",
          "updated_at": 1791559330.356224,
          "deleted_at": null,
          "created_at": 1791559330.356224,
          "mls": "NTREIS",
          "license_number": null,
          "designation": null,
          "nrds": "01053140",
          "type": "agent",
          "office_id": null,
          "secret_questions": [
            "(972) XXX-XX03",
            "jewellxxxxxxxxxxxxxal.net",
            "+1XXXXXXXX80"
          ]
        }
      ],
      "last_seen_type": null,
      "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "created_at": 1791559330.566206,
      "updated_at": 1791559330.566206,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
        "created_at": 1791559330.423046,
        "updated_at": 1791559330.423046,
        "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": [
        "bfc98f80-25ed-4539-a272-f431e29d9802"
      ],
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
    "template": "light",
    "attributes": {
      "biography": "Foo bar",
      "facebook_url": "http://facebook.com/foo"
    },
    "title": "Website Title",
    "template_instance": {
      "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
      "created_at": 1791559330.292516,
      "html": "SOME HTML",
      "file": {
        "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
        "created_at": 1791559330.959366,
        "updated_at": 1791559330.959366,
        "deleted_at": null,
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "mime": "image/png"
      },
      "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "branch": "http://mock-branch-url",
      "updated_at": 1791559330.292516,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "gracious-gould.rechat.site"
    ],
    "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "ord": "1"
  }
}

Update a website

Update a website
PUT/websites/:id

Example URI

PUT /websites/:id
URI Parameters
HideShow
id
string (required) Example: 3a81e80f-4dac-45ef-ab95-d147379789d1
Request
HideShow
Body
{
  "template": "light2",
  "title": "Website Title",
  "attributes": {
    "biography": "Foo bar",
    "facebook_url": "https://updated_facebook_url",
    "new_attribute": "value"
  },
  "user": "cb24db9a-ba25-424e-8697-2be40f11c71e"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "type": "website",
    "created_at": 1791559331.000551,
    "updated_at": 1791559331.176717,
    "user": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+14345711523",
      "created_at": 1791559330.300144,
      "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791559330.292516,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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,
      "bio": "This is my bio.",
      "current_time": "10:22 AM - Friday Oct 09, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
          "email": "[email protected]",
          "mlsid": "00920130",
          "fax": "(972) 264-4703",
          "full_name": "Gholi Sweet",
          "first_name": "Gholi",
          "last_name": "Sweet",
          "middle_name": null,
          "phone_number": "+19722644703",
          "nar_number": "797500044",
          "office_mui": "15512742",
          "status": "Active",
          "office_mlsid": "RCHT01X",
          "work_phone": "+14693588080",
          "generational_name": null,
          "matrix_unique_id": "775233133",
          "updated_at": 1791559330.356224,
          "deleted_at": null,
          "created_at": 1791559330.356224,
          "mls": "NTREIS",
          "license_number": null,
          "designation": null,
          "nrds": "01053140",
          "type": "agent",
          "office_id": null,
          "secret_questions": [
            "(972) XXX-XX03",
            "jewellxxxxxxxxxxxxxal.net",
            "+1XXXXXXXX80"
          ]
        }
      ],
      "last_seen_type": null,
      "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "created_at": 1791559330.566206,
      "updated_at": 1791559330.566206,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
        "created_at": 1791559330.423046,
        "updated_at": 1791559330.423046,
        "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": [
        "bfc98f80-25ed-4539-a272-f431e29d9802"
      ],
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
    "template": "light2",
    "attributes": {
      "biography": "Foo bar",
      "facebook_url": "https://updated_facebook_url",
      "new_attribute": "value"
    },
    "title": "Website Title",
    "template_instance": null,
    "hostnames": [
      "gracious-gould.rechat.site"
    ],
    "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "ord": "1"
  }
}

Get all user's websites

Get all user's websites
GET/websites

Example URI

GET /websites
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
      "type": "website",
      "created_at": 1791559331.000551,
      "updated_at": 1791559331.000772,
      "user": {
        "type": "user",
        "username": null,
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone_number": "+14345711523",
        "created_at": 1791559330.300144,
        "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1791559330.292516,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": false,
        "timezone": "America/Chicago",
        "user_type": "Agent",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": null,
        "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
        "brand": null,
        "fake_email": null,
        "features": null,
        "last_seen_at": null,
        "email_signature": "This is my signature.",
        "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,
        "bio": "This is my bio.",
        "current_time": "10:22 AM - Friday Oct 09, 2026",
        "push_allowed": true,
        "agents": [
          {
            "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
            "email": "[email protected]",
            "mlsid": "00920130",
            "fax": "(972) 264-4703",
            "full_name": "Gholi Sweet",
            "first_name": "Gholi",
            "last_name": "Sweet",
            "middle_name": null,
            "phone_number": "+19722644703",
            "nar_number": "797500044",
            "office_mui": "15512742",
            "status": "Active",
            "office_mlsid": "RCHT01X",
            "work_phone": "+14693588080",
            "generational_name": null,
            "matrix_unique_id": "775233133",
            "updated_at": 1791559330.356224,
            "deleted_at": null,
            "created_at": 1791559330.356224,
            "mls": "NTREIS",
            "license_number": null,
            "designation": null,
            "nrds": "01053140",
            "type": "agent",
            "office_id": null,
            "secret_questions": [
              "(972) XXX-XX03",
              "jewellxxxxxxxxxxxxxal.net",
              "+1XXXXXXXX80"
            ]
          }
        ],
        "last_seen_type": null,
        "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
        "display_name": "John Doe",
        "abbreviated_display_name": "John",
        "online_state": "Offline",
        "has_password": true
      },
      "brand": {
        "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
        "created_at": 1791559330.566206,
        "updated_at": 1791559330.566206,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
          "created_at": 1791559330.423046,
          "updated_at": 1791559330.423046,
          "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": [
          "bfc98f80-25ed-4539-a272-f431e29d9802"
        ],
        "type": "brand",
        "hostnames": null,
        "member_count": 1,
        "base_url": "https://irish.rechat.com"
      },
      "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "template": "light",
      "attributes": {
        "biography": "Foo bar",
        "facebook_url": "http://facebook.com/foo"
      },
      "title": "Website Title",
      "template_instance": {
        "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
        "created_at": 1791559330.292516,
        "html": "SOME HTML",
        "file": {
          "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
          "created_at": 1791559330.959366,
          "updated_at": 1791559330.959366,
          "deleted_at": null,
          "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
          "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
          "mime": "image/png"
        },
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "branch": "http://mock-branch-url",
        "updated_at": 1791559330.292516,
        "deleted_at": null,
        "type": "template_instance"
      },
      "hostnames": [
        "gracious-gould.rechat.site"
      ],
      "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
      "ord": "1"
    }
  ],
  "info": {
    "count": 1,
    "total": 0
  }
}

Get all brand's websites

Get all brand's websites
GET/brand/:brand/websites

Example URI

GET /brand/:brand/websites
URI Parameters
HideShow
brand
string (required) Example: 843d7061-696f-4e1a-b182-76a522aa34ad
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
      "type": "website",
      "created_at": 1791559331.000551,
      "updated_at": 1791559331.000772,
      "user": {
        "type": "user",
        "username": null,
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone_number": "+14345711523",
        "created_at": 1791559330.300144,
        "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1791559330.292516,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": false,
        "timezone": "America/Chicago",
        "user_type": "Agent",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": null,
        "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
        "brand": null,
        "fake_email": null,
        "features": null,
        "last_seen_at": null,
        "email_signature": "This is my signature.",
        "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,
        "bio": "This is my bio.",
        "current_time": "10:22 AM - Friday Oct 09, 2026",
        "push_allowed": true,
        "agents": [
          {
            "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
            "email": "[email protected]",
            "mlsid": "00920130",
            "fax": "(972) 264-4703",
            "full_name": "Gholi Sweet",
            "first_name": "Gholi",
            "last_name": "Sweet",
            "middle_name": null,
            "phone_number": "+19722644703",
            "nar_number": "797500044",
            "office_mui": "15512742",
            "status": "Active",
            "office_mlsid": "RCHT01X",
            "work_phone": "+14693588080",
            "generational_name": null,
            "matrix_unique_id": "775233133",
            "updated_at": 1791559330.356224,
            "deleted_at": null,
            "created_at": 1791559330.356224,
            "mls": "NTREIS",
            "license_number": null,
            "designation": null,
            "nrds": "01053140",
            "type": "agent",
            "office_id": null,
            "secret_questions": [
              "(972) XXX-XX03",
              "jewellxxxxxxxxxxxxxal.net",
              "+1XXXXXXXX80"
            ]
          }
        ],
        "last_seen_type": null,
        "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
        "display_name": "John Doe",
        "abbreviated_display_name": "John",
        "online_state": "Offline",
        "has_password": true
      },
      "brand": {
        "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
        "created_at": 1791559330.566206,
        "updated_at": 1791559330.566206,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
          "created_at": 1791559330.423046,
          "updated_at": 1791559330.423046,
          "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": [
          "bfc98f80-25ed-4539-a272-f431e29d9802"
        ],
        "type": "brand",
        "hostnames": null,
        "member_count": 1,
        "base_url": "https://irish.rechat.com"
      },
      "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "template": "light",
      "attributes": {
        "biography": "Foo bar",
        "facebook_url": "http://facebook.com/foo"
      },
      "title": "Website Title",
      "template_instance": {
        "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
        "created_at": 1791559330.292516,
        "html": "SOME HTML",
        "file": {
          "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
          "created_at": 1791559330.959366,
          "updated_at": 1791559330.959366,
          "deleted_at": null,
          "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
          "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
          "mime": "image/png"
        },
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "branch": "http://mock-branch-url",
        "updated_at": 1791559330.292516,
        "deleted_at": null,
        "type": "template_instance"
      },
      "hostnames": [
        "gracious-gould.rechat.site"
      ],
      "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
      "ord": "1"
    }
  ],
  "info": {
    "count": 1,
    "total": 1
  }
}

Add hostname to a website

Add hostname to a website
POST/websites/:id/hostnames

Example URI

POST /websites/:id/hostnames
URI Parameters
HideShow
id
string (required) Example: 3a81e80f-4dac-45ef-ab95-d147379789d1
Request
HideShow
Body
{
  "hostname": "localsite",
  "is_default": true
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "type": "website",
    "created_at": 1791559331.000551,
    "updated_at": 1791559331.000772,
    "user": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+14345711523",
      "created_at": 1791559330.300144,
      "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791559330.292516,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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,
      "bio": "This is my bio.",
      "current_time": "10:22 AM - Friday Oct 09, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
          "email": "[email protected]",
          "mlsid": "00920130",
          "fax": "(972) 264-4703",
          "full_name": "Gholi Sweet",
          "first_name": "Gholi",
          "last_name": "Sweet",
          "middle_name": null,
          "phone_number": "+19722644703",
          "nar_number": "797500044",
          "office_mui": "15512742",
          "status": "Active",
          "office_mlsid": "RCHT01X",
          "work_phone": "+14693588080",
          "generational_name": null,
          "matrix_unique_id": "775233133",
          "updated_at": 1791559330.356224,
          "deleted_at": null,
          "created_at": 1791559330.356224,
          "mls": "NTREIS",
          "license_number": null,
          "designation": null,
          "nrds": "01053140",
          "type": "agent",
          "office_id": null,
          "secret_questions": [
            "(972) XXX-XX03",
            "jewellxxxxxxxxxxxxxal.net",
            "+1XXXXXXXX80"
          ]
        }
      ],
      "last_seen_type": null,
      "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "created_at": 1791559330.566206,
      "updated_at": 1791559330.566206,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
        "created_at": 1791559330.423046,
        "updated_at": 1791559330.423046,
        "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": [
        "bfc98f80-25ed-4539-a272-f431e29d9802"
      ],
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
    "template": "light",
    "attributes": {
      "biography": "Foo bar",
      "facebook_url": "http://facebook.com/foo"
    },
    "title": "Website Title",
    "template_instance": {
      "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
      "created_at": 1791559330.292516,
      "html": "SOME HTML",
      "file": {
        "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
        "created_at": 1791559330.959366,
        "updated_at": 1791559330.959366,
        "deleted_at": null,
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "mime": "image/png"
      },
      "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "branch": "http://mock-branch-url",
      "updated_at": 1791559330.292516,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "localsite",
      "gracious-gould.rechat.site"
    ],
    "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "ord": "1"
  }
}

Delete hostname from a website

Delete hostname from a website
DELETE/websites/:id/hostnames?hostname=:hostname

Example URI

DELETE /websites/:id/hostnames?hostname=:hostname
URI Parameters
HideShow
id
string (required) Example: 3a81e80f-4dac-45ef-ab95-d147379789d1
hostname
string (required) Example: localsite
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "type": "website",
    "created_at": 1791559331.000551,
    "updated_at": 1791559331.000772,
    "user": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+14345711523",
      "created_at": 1791559330.300144,
      "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791559330.292516,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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,
      "bio": "This is my bio.",
      "current_time": "10:22 AM - Friday Oct 09, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
          "email": "[email protected]",
          "mlsid": "00920130",
          "fax": "(972) 264-4703",
          "full_name": "Gholi Sweet",
          "first_name": "Gholi",
          "last_name": "Sweet",
          "middle_name": null,
          "phone_number": "+19722644703",
          "nar_number": "797500044",
          "office_mui": "15512742",
          "status": "Active",
          "office_mlsid": "RCHT01X",
          "work_phone": "+14693588080",
          "generational_name": null,
          "matrix_unique_id": "775233133",
          "updated_at": 1791559330.356224,
          "deleted_at": null,
          "created_at": 1791559330.356224,
          "mls": "NTREIS",
          "license_number": null,
          "designation": null,
          "nrds": "01053140",
          "type": "agent",
          "office_id": null,
          "secret_questions": [
            "(972) XXX-XX03",
            "jewellxxxxxxxxxxxxxal.net",
            "+1XXXXXXXX80"
          ]
        }
      ],
      "last_seen_type": null,
      "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "created_at": 1791559330.566206,
      "updated_at": 1791559330.566206,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
        "created_at": 1791559330.423046,
        "updated_at": 1791559330.423046,
        "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": [
        "bfc98f80-25ed-4539-a272-f431e29d9802"
      ],
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
    "template": "light",
    "attributes": {
      "biography": "Foo bar",
      "facebook_url": "http://facebook.com/foo"
    },
    "title": "Website Title",
    "template_instance": {
      "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
      "created_at": 1791559330.292516,
      "html": "SOME HTML",
      "file": {
        "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
        "created_at": 1791559330.959366,
        "updated_at": 1791559330.959366,
        "deleted_at": null,
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "mime": "image/png"
      },
      "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "branch": "http://mock-branch-url",
      "updated_at": 1791559330.292516,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "gracious-gould.rechat.site"
    ],
    "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "ord": "1"
  }
}

Delete a website

Delete a website
DELETE/websites/:id

Example URI

DELETE /websites/:id
URI Parameters
HideShow
id
string (required) Example: 3a81e80f-4dac-45ef-ab95-d147379789d1
Request
HideShow
Body
{
  "user": "cb24db9a-ba25-424e-8697-2be40f11c71e"
}
Response  204

Find a website by its hostname

Find a website by its hostname
GET/websites/search?hostname=:hostname

Example URI

GET /websites/search?hostname=:hostname
URI Parameters
HideShow
hostname
string (required) Example: localsite
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "type": "website",
    "created_at": 1791559331.000551,
    "updated_at": 1791559331.000772,
    "user": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+14345711523",
      "created_at": 1791559330.300144,
      "id": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791559330.292516,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "cf89ac18-bcf9-4e94-af51-f89ce7d981f3",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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,
      "bio": "This is my bio.",
      "current_time": "10:22 AM - Friday Oct 09, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "bb170817-f359-47cc-b51d-d2fae60a75db",
          "email": "[email protected]",
          "mlsid": "00920130",
          "fax": "(972) 264-4703",
          "full_name": "Gholi Sweet",
          "first_name": "Gholi",
          "last_name": "Sweet",
          "middle_name": null,
          "phone_number": "+19722644703",
          "nar_number": "797500044",
          "office_mui": "15512742",
          "status": "Active",
          "office_mlsid": "RCHT01X",
          "work_phone": "+14693588080",
          "generational_name": null,
          "matrix_unique_id": "775233133",
          "updated_at": 1791559330.356224,
          "deleted_at": null,
          "created_at": 1791559330.356224,
          "mls": "NTREIS",
          "license_number": null,
          "designation": null,
          "nrds": "01053140",
          "type": "agent",
          "office_id": null,
          "secret_questions": [
            "(972) XXX-XX03",
            "jewellxxxxxxxxxxxxxal.net",
            "+1XXXXXXXX80"
          ]
        }
      ],
      "last_seen_type": null,
      "active_brand": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "843d7061-696f-4e1a-b182-76a522aa34ad",
      "created_at": 1791559330.566206,
      "updated_at": 1791559330.566206,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "bfc98f80-25ed-4539-a272-f431e29d9802",
        "created_at": 1791559330.423046,
        "updated_at": 1791559330.423046,
        "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": [
        "bfc98f80-25ed-4539-a272-f431e29d9802"
      ],
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "owner": "cb24db9a-ba25-424e-8697-2be40f11c71e",
    "template": "light",
    "attributes": {
      "biography": "Foo bar",
      "facebook_url": "http://facebook.com/foo"
    },
    "title": "Website Title",
    "template_instance": {
      "id": "f5b9eb70-5960-43dd-a096-99a2ac1f78d9",
      "created_at": 1791559330.292516,
      "html": "SOME HTML",
      "file": {
        "id": "5f93ca69-b0ca-469c-ab8f-af9e3ea2baaa",
        "created_at": 1791559330.959366,
        "updated_at": 1791559330.959366,
        "deleted_at": null,
        "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
        "path": "templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/32a9aae0-c3f5-11f1-a1c2-afecb13fce0e.png",
        "mime": "image/png"
      },
      "created_by": "cb24db9a-ba25-424e-8697-2be40f11c71e",
      "branch": "http://mock-branch-url",
      "updated_at": 1791559330.292516,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "localsite",
      "gracious-gould.rechat.site"
    ],
    "wid": "3a81e80f-4dac-45ef-ab95-d147379789d1",
    "ord": "1"
  }
}

Generated by aglio on 09 Oct 2026