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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
  "brand": "79d57af6-c466-41a7-834c-c56e35041c02",
  "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "type": "website",
    "created_at": 1770151252.073088,
    "updated_at": 1770151252.073359,
    "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": 1770151250.460713,
      "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": "2:40 PM - Tuesday Feb 03, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
          "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": 1770151250.538141,
          "deleted_at": null,
          "created_at": 1770151250.538141,
          "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": "79d57af6-c466-41a7-834c-c56e35041c02",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "79d57af6-c466-41a7-834c-c56e35041c02",
      "created_at": 1770151251.171937,
      "updated_at": 1770151251.171937,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "created_at": 1770151251.142866,
        "updated_at": 1770151251.142866,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
          "created_at": 1770151250.64244,
          "updated_at": 1770151250.64244,
          "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": [
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": [
        "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
      ],
      "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
      "created_at": 1770151250.460713,
      "html": "SOME HTML",
      "file": {
        "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
        "created_at": 1770151251.998822,
        "updated_at": 1770151251.998823,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151250.460713,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "funny-northcutt.undefined"
    ],
    "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "ord": "1"
  }
}

Get a website

Get a website
GET/websites/:id

Example URI

GET /websites/:id
URI Parameters
HideShow
id
string (required) Example: be11f692-2bb0-48e6-8108-40e971a9890c
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "type": "website",
    "created_at": 1770151252.073088,
    "updated_at": 1770151252.073359,
    "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": 1770151250.460713,
      "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": "2:40 PM - Tuesday Feb 03, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
          "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": 1770151250.538141,
          "deleted_at": null,
          "created_at": 1770151250.538141,
          "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": "79d57af6-c466-41a7-834c-c56e35041c02",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "79d57af6-c466-41a7-834c-c56e35041c02",
      "created_at": 1770151251.171937,
      "updated_at": 1770151251.171937,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "created_at": 1770151251.142866,
        "updated_at": 1770151251.142866,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
          "created_at": 1770151250.64244,
          "updated_at": 1770151250.64244,
          "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": [
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": [
        "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
      ],
      "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
      "created_at": 1770151250.460713,
      "html": "SOME HTML",
      "file": {
        "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
        "created_at": 1770151251.998822,
        "updated_at": 1770151251.998823,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151250.460713,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "funny-northcutt.undefined"
    ],
    "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "ord": "1"
  }
}

Update a website

Update a website
PUT/websites/:id

Example URI

PUT /websites/:id
URI Parameters
HideShow
id
string (required) Example: be11f692-2bb0-48e6-8108-40e971a9890c
Request
HideShow
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  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "type": "website",
    "created_at": 1770151252.073088,
    "updated_at": 1770151252.390536,
    "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": 1770151250.460713,
      "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": "2:40 PM - Tuesday Feb 03, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
          "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": 1770151250.538141,
          "deleted_at": null,
          "created_at": 1770151250.538141,
          "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": "79d57af6-c466-41a7-834c-c56e35041c02",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "79d57af6-c466-41a7-834c-c56e35041c02",
      "created_at": 1770151251.171937,
      "updated_at": 1770151251.171937,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "created_at": 1770151251.142866,
        "updated_at": 1770151251.142866,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
          "created_at": 1770151250.64244,
          "updated_at": 1770151250.64244,
          "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": [
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": [
        "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
      ],
      "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": [
      "funny-northcutt.undefined"
    ],
    "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "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": "be11f692-2bb0-48e6-8108-40e971a9890c",
      "type": "website",
      "created_at": 1770151252.073088,
      "updated_at": 1770151252.073359,
      "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": 1770151250.460713,
        "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": "2:40 PM - Tuesday Feb 03, 2026",
        "push_allowed": true,
        "agents": [
          {
            "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
            "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": 1770151250.538141,
            "deleted_at": null,
            "created_at": 1770151250.538141,
            "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": "79d57af6-c466-41a7-834c-c56e35041c02",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      },
      "brand": {
        "id": "79d57af6-c466-41a7-834c-c56e35041c02",
        "created_at": 1770151251.171937,
        "updated_at": 1770151251.171937,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
          "created_at": 1770151251.142866,
          "updated_at": 1770151251.142866,
          "palette": {
            "primary": "red",
            "type": "brand_palette"
          },
          "assets": {
            "type": "brand_assets"
          },
          "messages": {
            "type": "brand_messages"
          },
          "parent": {
            "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
            "created_at": 1770151250.64244,
            "updated_at": 1770151250.64244,
            "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": [
            "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
          ],
          "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": [
          "b9432c9a-f43f-4c53-b4e8-586f820938e7",
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
        "created_at": 1770151250.460713,
        "html": "SOME HTML",
        "file": {
          "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
          "created_at": 1770151251.998822,
          "updated_at": 1770151251.998823,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "mime": "image/png"
        },
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "branch": "http://mock-branch-url",
        "updated_at": 1770151250.460713,
        "deleted_at": null,
        "type": "template_instance"
      },
      "hostnames": [
        "funny-northcutt.undefined"
      ],
      "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
      "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: 79d57af6-c466-41a7-834c-c56e35041c02
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "be11f692-2bb0-48e6-8108-40e971a9890c",
      "type": "website",
      "created_at": 1770151252.073088,
      "updated_at": 1770151252.073359,
      "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": 1770151250.460713,
        "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": "2:40 PM - Tuesday Feb 03, 2026",
        "push_allowed": true,
        "agents": [
          {
            "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
            "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": 1770151250.538141,
            "deleted_at": null,
            "created_at": 1770151250.538141,
            "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": "79d57af6-c466-41a7-834c-c56e35041c02",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      },
      "brand": {
        "id": "79d57af6-c466-41a7-834c-c56e35041c02",
        "created_at": 1770151251.171937,
        "updated_at": 1770151251.171937,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
          "created_at": 1770151251.142866,
          "updated_at": 1770151251.142866,
          "palette": {
            "primary": "red",
            "type": "brand_palette"
          },
          "assets": {
            "type": "brand_assets"
          },
          "messages": {
            "type": "brand_messages"
          },
          "parent": {
            "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
            "created_at": 1770151250.64244,
            "updated_at": 1770151250.64244,
            "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": [
            "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
          ],
          "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": [
          "b9432c9a-f43f-4c53-b4e8-586f820938e7",
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
        "created_at": 1770151250.460713,
        "html": "SOME HTML",
        "file": {
          "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
          "created_at": 1770151251.998822,
          "updated_at": 1770151251.998823,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "mime": "image/png"
        },
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "branch": "http://mock-branch-url",
        "updated_at": 1770151250.460713,
        "deleted_at": null,
        "type": "template_instance"
      },
      "hostnames": [
        "funny-northcutt.undefined"
      ],
      "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
      "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: be11f692-2bb0-48e6-8108-40e971a9890c
Request
HideShow
Body
{
  "hostname": "localsite",
  "is_default": true,
  "website": "be11f692-2bb0-48e6-8108-40e971a9890c"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "type": "website",
    "created_at": 1770151252.073088,
    "updated_at": 1770151252.073359,
    "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": 1770151250.460713,
      "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": "2:40 PM - Tuesday Feb 03, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
          "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": 1770151250.538141,
          "deleted_at": null,
          "created_at": 1770151250.538141,
          "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": "79d57af6-c466-41a7-834c-c56e35041c02",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "79d57af6-c466-41a7-834c-c56e35041c02",
      "created_at": 1770151251.171937,
      "updated_at": 1770151251.171937,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "created_at": 1770151251.142866,
        "updated_at": 1770151251.142866,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
          "created_at": 1770151250.64244,
          "updated_at": 1770151250.64244,
          "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": [
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": [
        "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
      ],
      "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
      "created_at": 1770151250.460713,
      "html": "SOME HTML",
      "file": {
        "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
        "created_at": 1770151251.998822,
        "updated_at": 1770151251.998823,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151250.460713,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "localsite",
      "funny-northcutt.undefined"
    ],
    "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "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: be11f692-2bb0-48e6-8108-40e971a9890c
hostname
string (required) Example: localsite
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "type": "website",
    "created_at": 1770151252.073088,
    "updated_at": 1770151252.073359,
    "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": 1770151250.460713,
      "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": "2:40 PM - Tuesday Feb 03, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
          "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": 1770151250.538141,
          "deleted_at": null,
          "created_at": 1770151250.538141,
          "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": "79d57af6-c466-41a7-834c-c56e35041c02",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "79d57af6-c466-41a7-834c-c56e35041c02",
      "created_at": 1770151251.171937,
      "updated_at": 1770151251.171937,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "created_at": 1770151251.142866,
        "updated_at": 1770151251.142866,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
          "created_at": 1770151250.64244,
          "updated_at": 1770151250.64244,
          "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": [
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": [
        "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
      ],
      "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
      "created_at": 1770151250.460713,
      "html": "SOME HTML",
      "file": {
        "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
        "created_at": 1770151251.998822,
        "updated_at": 1770151251.998823,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151250.460713,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "funny-northcutt.undefined"
    ],
    "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "ord": "1"
  }
}

Delete a website

Delete a website
DELETE/websites/:id

Example URI

DELETE /websites/:id
URI Parameters
HideShow
id
string (required) Example: be11f692-2bb0-48e6-8108-40e971a9890c
Request
HideShow
Body
{
  "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
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": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "type": "website",
    "created_at": 1770151252.073088,
    "updated_at": 1770151252.073359,
    "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": 1770151250.460713,
      "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": "2:40 PM - Tuesday Feb 03, 2026",
      "push_allowed": true,
      "agents": [
        {
          "id": "20f94288-869f-4f52-a126-83c0c13f8ae0",
          "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": 1770151250.538141,
          "deleted_at": null,
          "created_at": 1770151250.538141,
          "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": "79d57af6-c466-41a7-834c-c56e35041c02",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "79d57af6-c466-41a7-834c-c56e35041c02",
      "created_at": 1770151251.171937,
      "updated_at": 1770151251.171937,
      "palette": {
        "primary": "red",
        "type": "brand_palette"
      },
      "assets": {
        "type": "brand_assets"
      },
      "messages": {
        "type": "brand_messages"
      },
      "parent": {
        "id": "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "created_at": 1770151251.142866,
        "updated_at": 1770151251.142866,
        "palette": {
          "primary": "red",
          "type": "brand_palette"
        },
        "assets": {
          "type": "brand_assets"
        },
        "messages": {
          "type": "brand_messages"
        },
        "parent": {
          "id": "c8e0c4a9-e82b-440f-8bfd-d30c6b704186",
          "created_at": 1770151250.64244,
          "updated_at": 1770151250.64244,
          "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": [
          "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
        ],
        "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": [
        "b9432c9a-f43f-4c53-b4e8-586f820938e7",
        "c8e0c4a9-e82b-440f-8bfd-d30c6b704186"
      ],
      "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": "c72ddd5d-cbe6-48c3-82f1-77ac99ebfec4",
      "created_at": 1770151250.460713,
      "html": "SOME HTML",
      "file": {
        "id": "58bc1c5b-b39c-4a41-84cb-bb2e01b87676",
        "created_at": 1770151251.998822,
        "updated_at": 1770151251.998823,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/a13eacd0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151250.460713,
      "deleted_at": null,
      "type": "template_instance"
    },
    "hostnames": [
      "localsite",
      "funny-northcutt.undefined"
    ],
    "wid": "be11f692-2bb0-48e6-8108-40e971a9890c",
    "ord": "1"
  }
}

Generated by aglio on 03 Feb 2026