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: f23e5535-bd73-4fd7-be67-88a0488d9dbd
Request
HideShow
Body
{
  "title": "title",
  "content": "content",
  "parent": null
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
    "type": "page",
    "created_at": 1760470087.72992,
    "updated_at": 1760470087.734935,
    "parent": null,
    "created_by": "a2ae4d77-739b-41ba-a8e2-b15fce1b63c7",
    "title": "title",
    "content": "content",
    "page_id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
    "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: f23e5535-bd73-4fd7-be67-88a0488d9dbd
id
string (required) Example: 36a55210-12ce-4d07-8d18-0881e8eb0086
Request
HideShow
Body
{
  "title": "title",
  "content": "content"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
    "type": "page",
    "created_at": 1760470087.72992,
    "updated_at": 1760470088.332803,
    "parent": null,
    "created_by": "a2ae4d77-739b-41ba-a8e2-b15fce1b63c7",
    "title": "title",
    "content": "content",
    "page_id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
    "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: f23e5535-bd73-4fd7-be67-88a0488d9dbd
id
string (required) Example: 36a55210-12ce-4d07-8d18-0881e8eb0086
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: f23e5535-bd73-4fd7-be67-88a0488d9dbd
associations
string (required) Example: page.children,page.attachments
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
      "type": "page",
      "created_at": 1760470087.72992,
      "updated_at": 1760470088.332803,
      "parent": null,
      "created_by": "a2ae4d77-739b-41ba-a8e2-b15fce1b63c7",
      "title": "title",
      "content": "content",
      "children": null,
      "attachments": [
        {
          "id": "3980cd40-b0e4-451a-9793-d7b174d8fa70",
          "created_at": 1760470088.984047,
          "updated_at": 1760470088.984047,
          "deleted_at": null,
          "created_by": "a2ae4d77-739b-41ba-a8e2-b15fce1b63c7",
          "path": "pages/36a55210-12ce-4d07-8d18-0881e8eb0086/attachments/ea6af630-a933-11f0-bdea-d5cf17ea076e.jpg",
          "name": "sample.jpg",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/pages/36a55210-12ce-4d07-8d18-0881e8eb0086/attachments/ea6af630-a933-11f0-bdea-d5cf17ea076e.jpg?Expires=1760556488991&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=HNWLJ2oPlAIWIrdy06-jRzgBXB1SrnMTMEUo~otfJxVChZXIT89r6jz8VBYlsu5PuokmzSoD1agPVm9ktnJZziNGxspr7l2fIjSTJUfPKQzk5zjcpenBWsHg5-1LOmLiktqjGJKHDiM0FgYZ1Mfd9RQJNb7VZB~UQkpKAlBPWy1O0paoH57TYmKkgT8vJtOPrR7hnATirmfG36JPCUOdqlYj9xlsj5kSEh823EEh22weV7RGvv7MkBKyxrEGnw8unKCyRwChH4VQRyLTzyO3Hd0qIwDu8AdN2kfdVMN4m7ulsGTOdKroWg6TD~sdYCqPc5jI6Jo1SuAC2iNXr0BydQ__",
          "preview_url": "https://private-cdn.irish.rechat.com/pages/36a55210-12ce-4d07-8d18-0881e8eb0086/attachments/ea6af630-a933-11f0-bdea-d5cf17ea076e.jpg?Expires=1760556488991&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=HNWLJ2oPlAIWIrdy06-jRzgBXB1SrnMTMEUo~otfJxVChZXIT89r6jz8VBYlsu5PuokmzSoD1agPVm9ktnJZziNGxspr7l2fIjSTJUfPKQzk5zjcpenBWsHg5-1LOmLiktqjGJKHDiM0FgYZ1Mfd9RQJNb7VZB~UQkpKAlBPWy1O0paoH57TYmKkgT8vJtOPrR7hnATirmfG36JPCUOdqlYj9xlsj5kSEh823EEh22weV7RGvv7MkBKyxrEGnw8unKCyRwChH4VQRyLTzyO3Hd0qIwDu8AdN2kfdVMN4m7ulsGTOdKroWg6TD~sdYCqPc5jI6Jo1SuAC2iNXr0BydQ__",
          "mime": "image/jpeg"
        }
      ],
      "page_id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
      "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: f23e5535-bd73-4fd7-be67-88a0488d9dbd
id
string (required) Example: 36a55210-12ce-4d07-8d18-0881e8eb0086
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
    "type": "page",
    "created_at": 1760470087.72992,
    "updated_at": 1760470088.332803,
    "parent": null,
    "created_by": "a2ae4d77-739b-41ba-a8e2-b15fce1b63c7",
    "title": "title",
    "content": "content",
    "page_id": "36a55210-12ce-4d07-8d18-0881e8eb0086",
    "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: f23e5535-bd73-4fd7-be67-88a0488d9dbd
id
string (required) Example: 36a55210-12ce-4d07-8d18-0881e8eb0086
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3980cd40-b0e4-451a-9793-d7b174d8fa70",
    "created_at": 1760470088.984047,
    "updated_at": 1760470088.984047,
    "deleted_at": null,
    "created_by": "a2ae4d77-739b-41ba-a8e2-b15fce1b63c7",
    "path": "pages/36a55210-12ce-4d07-8d18-0881e8eb0086/attachments/ea6af630-a933-11f0-bdea-d5cf17ea076e.jpg",
    "name": "sample.jpg",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/pages/36a55210-12ce-4d07-8d18-0881e8eb0086/attachments/ea6af630-a933-11f0-bdea-d5cf17ea076e.jpg?Expires=1760556488991&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=HNWLJ2oPlAIWIrdy06-jRzgBXB1SrnMTMEUo~otfJxVChZXIT89r6jz8VBYlsu5PuokmzSoD1agPVm9ktnJZziNGxspr7l2fIjSTJUfPKQzk5zjcpenBWsHg5-1LOmLiktqjGJKHDiM0FgYZ1Mfd9RQJNb7VZB~UQkpKAlBPWy1O0paoH57TYmKkgT8vJtOPrR7hnATirmfG36JPCUOdqlYj9xlsj5kSEh823EEh22weV7RGvv7MkBKyxrEGnw8unKCyRwChH4VQRyLTzyO3Hd0qIwDu8AdN2kfdVMN4m7ulsGTOdKroWg6TD~sdYCqPc5jI6Jo1SuAC2iNXr0BydQ__",
    "preview_url": "https://private-cdn.irish.rechat.com/pages/36a55210-12ce-4d07-8d18-0881e8eb0086/attachments/ea6af630-a933-11f0-bdea-d5cf17ea076e.jpg?Expires=1760556488991&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=HNWLJ2oPlAIWIrdy06-jRzgBXB1SrnMTMEUo~otfJxVChZXIT89r6jz8VBYlsu5PuokmzSoD1agPVm9ktnJZziNGxspr7l2fIjSTJUfPKQzk5zjcpenBWsHg5-1LOmLiktqjGJKHDiM0FgYZ1Mfd9RQJNb7VZB~UQkpKAlBPWy1O0paoH57TYmKkgT8vJtOPrR7hnATirmfG36JPCUOdqlYj9xlsj5kSEh823EEh22weV7RGvv7MkBKyxrEGnw8unKCyRwChH4VQRyLTzyO3Hd0qIwDu8AdN2kfdVMN4m7ulsGTOdKroWg6TD~sdYCqPc5jI6Jo1SuAC2iNXr0BydQ__",
    "mime": "image/jpeg"
  }
}

Generated by aglio on 14 Oct 2025