Back to top

Page

Overview

Pages help to organize and share information within a brand.

Each page has the following attributes:

  • Brand the page blongs to

  • Content that contains HTML

  • Title of the page

Brand admins can create, modify and delete pages while agents can read them.

Resource Group

Create a page

Create a page
POST/brands/:brand/pages

Example URI

POST /brands/:brand/pages
URI Parameters
HideShow
brand
string (required) Example: 39669d07-5a09-40a1-bd48-bba38f1af5a9
Request
HideShow
Body
{
  "title": "title",
  "content": "content",
  "parent": null
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "08779c08-601e-4d04-adce-6868722ec4b0",
    "type": "page",
    "created_at": 1765163614.274727,
    "updated_at": 1765163614.278523,
    "parent": null,
    "created_by": "811e6d99-3a92-4717-ba58-8a36c7377881",
    "title": "title",
    "content": "content",
    "page_id": "08779c08-601e-4d04-adce-6868722ec4b0",
    "ord": "1"
  }
}

Update a page

Update a page
PUT/brands/:brand/pages/:id

Example URI

PUT /brands/:brand/pages/:id
URI Parameters
HideShow
brand
string (required) Example: 39669d07-5a09-40a1-bd48-bba38f1af5a9
id
string (required) Example: 08779c08-601e-4d04-adce-6868722ec4b0
Request
HideShow
Body
{
  "title": "title",
  "content": "content"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "08779c08-601e-4d04-adce-6868722ec4b0",
    "type": "page",
    "created_at": 1765163614.274727,
    "updated_at": 1765163614.786722,
    "parent": null,
    "created_by": "811e6d99-3a92-4717-ba58-8a36c7377881",
    "title": "title",
    "content": "content",
    "page_id": "08779c08-601e-4d04-adce-6868722ec4b0",
    "ord": "1"
  }
}

Delete a page

Delete a page
DELETE/brands/:brand/pages/:id

Example URI

DELETE /brands/:brand/pages/:id
URI Parameters
HideShow
brand
string (required) Example: 39669d07-5a09-40a1-bd48-bba38f1af5a9
id
string (required) Example: 08779c08-601e-4d04-adce-6868722ec4b0
Response  204

Get pages of a brand

Get pages of a brand
GET/brands/:brand/pages

Example URI

GET /brands/:brand/pages
URI Parameters
HideShow
brand
string (required) Example: 39669d07-5a09-40a1-bd48-bba38f1af5a9
associations
string (required) Example: page.children,page.attachments
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "08779c08-601e-4d04-adce-6868722ec4b0",
      "type": "page",
      "created_at": 1765163614.274727,
      "updated_at": 1765163614.786722,
      "parent": null,
      "created_by": "811e6d99-3a92-4717-ba58-8a36c7377881",
      "title": "title",
      "content": "content",
      "children": null,
      "attachments": [
        {
          "id": "f023585d-466b-4239-9e23-8e16a75944aa",
          "created_at": 1765163615.028236,
          "updated_at": 1765163615.028236,
          "deleted_at": null,
          "created_by": "811e6d99-3a92-4717-ba58-8a36c7377881",
          "path": "pages/08779c08-601e-4d04-adce-6868722ec4b0/attachments/e1f1c300-d3e3-11f0-a2d4-1bcac3894d4e.jpg",
          "name": "sample.jpg",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/pages/08779c08-601e-4d04-adce-6868722ec4b0/attachments/e1f1c300-d3e3-11f0-a2d4-1bcac3894d4e.jpg?Expires=1765250015033&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=J28XcV3~-rql3jUSeNl4roCjGsYdOAs3I7NQ~LokrDl7B-AWmW~gq8fn8UZamz1YsyVUn3gvpZgFylFnjVXL7NpJMzDtJwwSTiWgCYg0eCPQhokFreNMJrKzoontCaonCNvktHfZ1Bkv7uAdHTXyM41Rfk-RGdolbc9lf4zlyeFvGqEESBU7zs1O95~XjUWtLU-wVjFrTFfUW8m9BqavFxeE3tYrCrZHW3KJM7cCZCay13k-BktoX7Uu9miHv2-ikcIvShJcjEji9tEF6kR-vF-jPANGlcaUy-g8nUsaM4tIfbh2rQpy3FYM2KvnDRXlxXrLe0mzi9tjKFXoUp0IXA__",
          "preview_url": "https://private-cdn.irish.rechat.com/pages/08779c08-601e-4d04-adce-6868722ec4b0/attachments/e1f1c300-d3e3-11f0-a2d4-1bcac3894d4e.jpg?Expires=1765250015033&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=J28XcV3~-rql3jUSeNl4roCjGsYdOAs3I7NQ~LokrDl7B-AWmW~gq8fn8UZamz1YsyVUn3gvpZgFylFnjVXL7NpJMzDtJwwSTiWgCYg0eCPQhokFreNMJrKzoontCaonCNvktHfZ1Bkv7uAdHTXyM41Rfk-RGdolbc9lf4zlyeFvGqEESBU7zs1O95~XjUWtLU-wVjFrTFfUW8m9BqavFxeE3tYrCrZHW3KJM7cCZCay13k-BktoX7Uu9miHv2-ikcIvShJcjEji9tEF6kR-vF-jPANGlcaUy-g8nUsaM4tIfbh2rQpy3FYM2KvnDRXlxXrLe0mzi9tjKFXoUp0IXA__",
          "mime": "image/jpeg"
        }
      ],
      "page_id": "08779c08-601e-4d04-adce-6868722ec4b0",
      "ord": "1"
    }
  ],
  "info": {
    "count": 1,
    "total": 0
  }
}

Get a page

Get a page
GET/brands/:brand/pages/:id

Example URI

GET /brands/:brand/pages/:id
URI Parameters
HideShow
brand
string (required) Example: 39669d07-5a09-40a1-bd48-bba38f1af5a9
id
string (required) Example: 08779c08-601e-4d04-adce-6868722ec4b0
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "08779c08-601e-4d04-adce-6868722ec4b0",
    "type": "page",
    "created_at": 1765163614.274727,
    "updated_at": 1765163614.786722,
    "parent": null,
    "created_by": "811e6d99-3a92-4717-ba58-8a36c7377881",
    "title": "title",
    "content": "content",
    "page_id": "08779c08-601e-4d04-adce-6868722ec4b0",
    "ord": "1"
  }
}

Upload attachment to the brand for pages

Upload attachment to the brand for pages
POST/brands/:brand/pages/attachments

Example URI

POST /brands/:brand/pages/attachments
URI Parameters
HideShow
brand
string (required) Example: 39669d07-5a09-40a1-bd48-bba38f1af5a9
id
string (required) Example: 08779c08-601e-4d04-adce-6868722ec4b0
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f023585d-466b-4239-9e23-8e16a75944aa",
    "created_at": 1765163615.028236,
    "updated_at": 1765163615.028236,
    "deleted_at": null,
    "created_by": "811e6d99-3a92-4717-ba58-8a36c7377881",
    "path": "pages/08779c08-601e-4d04-adce-6868722ec4b0/attachments/e1f1c300-d3e3-11f0-a2d4-1bcac3894d4e.jpg",
    "name": "sample.jpg",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/pages/08779c08-601e-4d04-adce-6868722ec4b0/attachments/e1f1c300-d3e3-11f0-a2d4-1bcac3894d4e.jpg?Expires=1765250015033&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=J28XcV3~-rql3jUSeNl4roCjGsYdOAs3I7NQ~LokrDl7B-AWmW~gq8fn8UZamz1YsyVUn3gvpZgFylFnjVXL7NpJMzDtJwwSTiWgCYg0eCPQhokFreNMJrKzoontCaonCNvktHfZ1Bkv7uAdHTXyM41Rfk-RGdolbc9lf4zlyeFvGqEESBU7zs1O95~XjUWtLU-wVjFrTFfUW8m9BqavFxeE3tYrCrZHW3KJM7cCZCay13k-BktoX7Uu9miHv2-ikcIvShJcjEji9tEF6kR-vF-jPANGlcaUy-g8nUsaM4tIfbh2rQpy3FYM2KvnDRXlxXrLe0mzi9tjKFXoUp0IXA__",
    "preview_url": "https://private-cdn.irish.rechat.com/pages/08779c08-601e-4d04-adce-6868722ec4b0/attachments/e1f1c300-d3e3-11f0-a2d4-1bcac3894d4e.jpg?Expires=1765250015033&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=J28XcV3~-rql3jUSeNl4roCjGsYdOAs3I7NQ~LokrDl7B-AWmW~gq8fn8UZamz1YsyVUn3gvpZgFylFnjVXL7NpJMzDtJwwSTiWgCYg0eCPQhokFreNMJrKzoontCaonCNvktHfZ1Bkv7uAdHTXyM41Rfk-RGdolbc9lf4zlyeFvGqEESBU7zs1O95~XjUWtLU-wVjFrTFfUW8m9BqavFxeE3tYrCrZHW3KJM7cCZCay13k-BktoX7Uu9miHv2-ikcIvShJcjEji9tEF6kR-vF-jPANGlcaUy-g8nUsaM4tIfbh2rQpy3FYM2KvnDRXlxXrLe0mzi9tjKFXoUp0IXA__",
    "mime": "image/jpeg"
  }
}

Generated by aglio on 08 Dec 2025