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: 13fd1b31-6d1b-4abc-a673-5cc0ba02d9d3
Request
HideShow
Body
{
  "title": "title",
  "content": "content",
  "parent": null
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
    "type": "page",
    "created_at": 1769132578.750314,
    "updated_at": 1769132578.754396,
    "parent": null,
    "created_by": "49177609-9b0e-4a90-8a3e-11f3201ed5e5",
    "title": "title",
    "content": "content",
    "page_id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
    "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: 13fd1b31-6d1b-4abc-a673-5cc0ba02d9d3
id
string (required) Example: 2aae18e1-a498-41b7-a5b1-a56b66fa45a9
Request
HideShow
Body
{
  "title": "title",
  "content": "content"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
    "type": "page",
    "created_at": 1769132578.750314,
    "updated_at": 1769132579.289993,
    "parent": null,
    "created_by": "49177609-9b0e-4a90-8a3e-11f3201ed5e5",
    "title": "title",
    "content": "content",
    "page_id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
    "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: 13fd1b31-6d1b-4abc-a673-5cc0ba02d9d3
id
string (required) Example: 2aae18e1-a498-41b7-a5b1-a56b66fa45a9
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: 13fd1b31-6d1b-4abc-a673-5cc0ba02d9d3
associations
string (required) Example: page.children,page.attachments
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
      "type": "page",
      "created_at": 1769132578.750314,
      "updated_at": 1769132579.289993,
      "parent": null,
      "created_by": "49177609-9b0e-4a90-8a3e-11f3201ed5e5",
      "title": "title",
      "content": "content",
      "children": null,
      "attachments": [
        {
          "id": "24013f4e-b11c-4bb3-a00b-c741e933e3df",
          "created_at": 1769132579.827642,
          "updated_at": 1769132579.827643,
          "deleted_at": null,
          "created_by": "49177609-9b0e-4a90-8a3e-11f3201ed5e5",
          "path": "pages/2aae18e1-a498-41b7-a5b1-a56b66fa45a9/attachments/d9508f00-f7fc-11f0-8c7d-09c4c6e349ce.jpg",
          "name": "sample.jpg",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/pages/2aae18e1-a498-41b7-a5b1-a56b66fa45a9/attachments/d9508f00-f7fc-11f0-8c7d-09c4c6e349ce.jpg?Expires=1769218979830&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SulRjPQL~wS-MjtUUTmnaLiyoMAKs40eqEgED676riX-ZZt7OMoKvdbapme7H6ZgWZUpSxLJFtZBHdJjHU9f0xVq8d4y1hgHw9XbP1QLjKKSza7u3U0~oXGCp0POaF9q5CMs3SOccZmqdwNumQecucbvaLoEmlpXyrjsZWfvRp1LDf06HsWYiNUZi0tXajdrtvpZ1t6fy3CP0lkEHghOmDVrFAKuYYyrlQPFytGR519MgtHyt3kjSSPzqSm-Vlxgh2ONDx9-uNZjAiPIWwurEYPYMkrrLnmI96KDnsedK7bkzzoNi30Ghnuq0yWX47FGPBv~zHACRQwwU7s2KW2-DQ__",
          "preview_url": "https://private-cdn.irish.rechat.com/pages/2aae18e1-a498-41b7-a5b1-a56b66fa45a9/attachments/d9508f00-f7fc-11f0-8c7d-09c4c6e349ce.jpg?Expires=1769218979830&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SulRjPQL~wS-MjtUUTmnaLiyoMAKs40eqEgED676riX-ZZt7OMoKvdbapme7H6ZgWZUpSxLJFtZBHdJjHU9f0xVq8d4y1hgHw9XbP1QLjKKSza7u3U0~oXGCp0POaF9q5CMs3SOccZmqdwNumQecucbvaLoEmlpXyrjsZWfvRp1LDf06HsWYiNUZi0tXajdrtvpZ1t6fy3CP0lkEHghOmDVrFAKuYYyrlQPFytGR519MgtHyt3kjSSPzqSm-Vlxgh2ONDx9-uNZjAiPIWwurEYPYMkrrLnmI96KDnsedK7bkzzoNi30Ghnuq0yWX47FGPBv~zHACRQwwU7s2KW2-DQ__",
          "mime": "image/jpeg"
        }
      ],
      "page_id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
      "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: 13fd1b31-6d1b-4abc-a673-5cc0ba02d9d3
id
string (required) Example: 2aae18e1-a498-41b7-a5b1-a56b66fa45a9
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
    "type": "page",
    "created_at": 1769132578.750314,
    "updated_at": 1769132579.289993,
    "parent": null,
    "created_by": "49177609-9b0e-4a90-8a3e-11f3201ed5e5",
    "title": "title",
    "content": "content",
    "page_id": "2aae18e1-a498-41b7-a5b1-a56b66fa45a9",
    "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: 13fd1b31-6d1b-4abc-a673-5cc0ba02d9d3
id
string (required) Example: 2aae18e1-a498-41b7-a5b1-a56b66fa45a9
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "24013f4e-b11c-4bb3-a00b-c741e933e3df",
    "created_at": 1769132579.827642,
    "updated_at": 1769132579.827643,
    "deleted_at": null,
    "created_by": "49177609-9b0e-4a90-8a3e-11f3201ed5e5",
    "path": "pages/2aae18e1-a498-41b7-a5b1-a56b66fa45a9/attachments/d9508f00-f7fc-11f0-8c7d-09c4c6e349ce.jpg",
    "name": "sample.jpg",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/pages/2aae18e1-a498-41b7-a5b1-a56b66fa45a9/attachments/d9508f00-f7fc-11f0-8c7d-09c4c6e349ce.jpg?Expires=1769218979830&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SulRjPQL~wS-MjtUUTmnaLiyoMAKs40eqEgED676riX-ZZt7OMoKvdbapme7H6ZgWZUpSxLJFtZBHdJjHU9f0xVq8d4y1hgHw9XbP1QLjKKSza7u3U0~oXGCp0POaF9q5CMs3SOccZmqdwNumQecucbvaLoEmlpXyrjsZWfvRp1LDf06HsWYiNUZi0tXajdrtvpZ1t6fy3CP0lkEHghOmDVrFAKuYYyrlQPFytGR519MgtHyt3kjSSPzqSm-Vlxgh2ONDx9-uNZjAiPIWwurEYPYMkrrLnmI96KDnsedK7bkzzoNi30Ghnuq0yWX47FGPBv~zHACRQwwU7s2KW2-DQ__",
    "preview_url": "https://private-cdn.irish.rechat.com/pages/2aae18e1-a498-41b7-a5b1-a56b66fa45a9/attachments/d9508f00-f7fc-11f0-8c7d-09c4c6e349ce.jpg?Expires=1769218979830&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SulRjPQL~wS-MjtUUTmnaLiyoMAKs40eqEgED676riX-ZZt7OMoKvdbapme7H6ZgWZUpSxLJFtZBHdJjHU9f0xVq8d4y1hgHw9XbP1QLjKKSza7u3U0~oXGCp0POaF9q5CMs3SOccZmqdwNumQecucbvaLoEmlpXyrjsZWfvRp1LDf06HsWYiNUZi0tXajdrtvpZ1t6fy3CP0lkEHghOmDVrFAKuYYyrlQPFytGR519MgtHyt3kjSSPzqSm-Vlxgh2ONDx9-uNZjAiPIWwurEYPYMkrrLnmI96KDnsedK7bkzzoNi30Ghnuq0yWX47FGPBv~zHACRQwwU7s2KW2-DQ__",
    "mime": "image/jpeg"
  }
}

Generated by aglio on 23 Jan 2026