Back to top

Page

Overview

Pages help to organize and share information within a brand.

Each page has the following attributes:

  • Brand the page belongs to

  • Content that contains HTML

  • Title of the page

  • Order of the page

Brand admins can create, modify, reorder 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: 01a48fd2-18bf-43fe-809d-0651e9b10e70
Request
HideShow
Body
{
  "title": "title",
  "order": 1,
  "content": "content",
  "parent": null,
  "icon": "💧"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
    "type": "page",
    "created_at": 1774173547.93015,
    "updated_at": 1774173547.934401,
    "parent": null,
    "order": 1,
    "created_by": "842babb0-c359-45a2-9c15-f3219616cefb",
    "title": "title",
    "content": "content",
    "icon": "💧",
    "page_id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
    "ord": "1"
  }
}

Update sorting orders for one or more pages

Update sorting orders for one or more pages
PUT/brands/:brand/pages/sort

Example URI

PUT /brands/:brand/pages/sort
URI Parameters
HideShow
brand
string (required) Example: 01a48fd2-18bf-43fe-809d-0651e9b10e70
Request
HideShow
Body
[
  {
    "id": "3f504b01-82c9-423e-9c3b-38981fac1e00",
    "order": 95
  },
  {
    "id": "7ba93dce-d776-4ea0-a608-215332704d4f",
    "order": 85
  },
  {
    "id": "8d71cee9-a146-43ab-be7f-cd2ccaf5c023",
    "order": 90,
    "parent": "b6eac35d-f6d0-49c7-98db-e444610964e6"
  }
]
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "3f504b01-82c9-423e-9c3b-38981fac1e00",
      "order": 95,
      "parent": null
    },
    {
      "id": "7ba93dce-d776-4ea0-a608-215332704d4f",
      "order": 85,
      "parent": null
    },
    {
      "id": "8d71cee9-a146-43ab-be7f-cd2ccaf5c023",
      "order": 90,
      "parent": "b6eac35d-f6d0-49c7-98db-e444610964e6"
    }
  ],
  "info": {
    "count": 3,
    "total": 0
  }
}

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: 01a48fd2-18bf-43fe-809d-0651e9b10e70
id
string (required) Example: a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6
Request
HideShow
Body
{
  "title": "title",
  "content": "content",
  "icon": "💧"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
    "type": "page",
    "created_at": 1774173547.93015,
    "updated_at": 1774173548.471436,
    "parent": null,
    "order": 1,
    "created_by": "842babb0-c359-45a2-9c15-f3219616cefb",
    "title": "title",
    "content": "content",
    "icon": "💧",
    "page_id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
    "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: 01a48fd2-18bf-43fe-809d-0651e9b10e70
id
string (required) Example: a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6
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: 01a48fd2-18bf-43fe-809d-0651e9b10e70
associations
string (required) Example: page.children,page.attachments
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
      "type": "page",
      "created_at": 1774173547.93015,
      "updated_at": 1774173548.471436,
      "parent": null,
      "order": 1,
      "created_by": "842babb0-c359-45a2-9c15-f3219616cefb",
      "title": "title",
      "content": "content",
      "icon": "💧",
      "children": null,
      "attachments": [
        {
          "id": "91b37f99-421b-49f5-a9d7-89734344192c",
          "created_at": 1774173548.837341,
          "updated_at": 1774173548.837341,
          "deleted_at": null,
          "created_by": "842babb0-c359-45a2-9c15-f3219616cefb",
          "path": "pages/a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6/attachments/c4fc3200-25d5-11f1-83ca-c9fd0d26db3c.jpg",
          "name": "sample.jpg",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/pages/a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6/attachments/c4fc3200-25d5-11f1-83ca-c9fd0d26db3c.jpg?Expires=1774259948841&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RwyWu6udVF08DSXgaTonck0QXoLzvrWwFpIAnSJajhQIB5rwHZGREJTSlAk3aBDZuIpN5fbxN-xd0LxFj50~wiUCRSppb-zeRi302VvPXChMFGcSUivxbPMtmQ9mbkhDkyrxtlLEsdLRlvoql1kGrEJifs1dyTlVC5flWDEnqFpRkvvzAHpNr0bqwbknirmkNFnlke0nUhESr4AWoYE8iNZZ6RDJ6Oqmm4zMkIGSnHL7P6KKknafm0oef7h6A8KMGIgBVKYOYJT4R5v9bgOGkqErq1f0prlOhU0EzcwqTXgk732FOuuebRMSezLbvvVaS58NxtKvV97g7ypT6t-5dw__",
          "preview_url": "https://private-cdn.irish.rechat.com/pages/a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6/attachments/c4fc3200-25d5-11f1-83ca-c9fd0d26db3c.jpg?Expires=1774259948841&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RwyWu6udVF08DSXgaTonck0QXoLzvrWwFpIAnSJajhQIB5rwHZGREJTSlAk3aBDZuIpN5fbxN-xd0LxFj50~wiUCRSppb-zeRi302VvPXChMFGcSUivxbPMtmQ9mbkhDkyrxtlLEsdLRlvoql1kGrEJifs1dyTlVC5flWDEnqFpRkvvzAHpNr0bqwbknirmkNFnlke0nUhESr4AWoYE8iNZZ6RDJ6Oqmm4zMkIGSnHL7P6KKknafm0oef7h6A8KMGIgBVKYOYJT4R5v9bgOGkqErq1f0prlOhU0EzcwqTXgk732FOuuebRMSezLbvvVaS58NxtKvV97g7ypT6t-5dw__",
          "mime": "image/jpeg"
        }
      ],
      "page_id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
      "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: 01a48fd2-18bf-43fe-809d-0651e9b10e70
id
string (required) Example: a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
    "type": "page",
    "created_at": 1774173547.93015,
    "updated_at": 1774173548.471436,
    "parent": null,
    "order": 1,
    "created_by": "842babb0-c359-45a2-9c15-f3219616cefb",
    "title": "title",
    "content": "content",
    "icon": "💧",
    "page_id": "a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6",
    "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: 01a48fd2-18bf-43fe-809d-0651e9b10e70
id
string (required) Example: a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "91b37f99-421b-49f5-a9d7-89734344192c",
    "created_at": 1774173548.837341,
    "updated_at": 1774173548.837341,
    "deleted_at": null,
    "created_by": "842babb0-c359-45a2-9c15-f3219616cefb",
    "path": "pages/a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6/attachments/c4fc3200-25d5-11f1-83ca-c9fd0d26db3c.jpg",
    "name": "sample.jpg",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/pages/a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6/attachments/c4fc3200-25d5-11f1-83ca-c9fd0d26db3c.jpg?Expires=1774259948841&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RwyWu6udVF08DSXgaTonck0QXoLzvrWwFpIAnSJajhQIB5rwHZGREJTSlAk3aBDZuIpN5fbxN-xd0LxFj50~wiUCRSppb-zeRi302VvPXChMFGcSUivxbPMtmQ9mbkhDkyrxtlLEsdLRlvoql1kGrEJifs1dyTlVC5flWDEnqFpRkvvzAHpNr0bqwbknirmkNFnlke0nUhESr4AWoYE8iNZZ6RDJ6Oqmm4zMkIGSnHL7P6KKknafm0oef7h6A8KMGIgBVKYOYJT4R5v9bgOGkqErq1f0prlOhU0EzcwqTXgk732FOuuebRMSezLbvvVaS58NxtKvV97g7ypT6t-5dw__",
    "preview_url": "https://private-cdn.irish.rechat.com/pages/a72dbe86-ecb8-4d4a-9b0a-7a151d8cc9e6/attachments/c4fc3200-25d5-11f1-83ca-c9fd0d26db3c.jpg?Expires=1774259948841&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RwyWu6udVF08DSXgaTonck0QXoLzvrWwFpIAnSJajhQIB5rwHZGREJTSlAk3aBDZuIpN5fbxN-xd0LxFj50~wiUCRSppb-zeRi302VvPXChMFGcSUivxbPMtmQ9mbkhDkyrxtlLEsdLRlvoql1kGrEJifs1dyTlVC5flWDEnqFpRkvvzAHpNr0bqwbknirmkNFnlke0nUhESr4AWoYE8iNZZ6RDJ6Oqmm4zMkIGSnHL7P6KKknafm0oef7h6A8KMGIgBVKYOYJT4R5v9bgOGkqErq1f0prlOhU0EzcwqTXgk732FOuuebRMSezLbvvVaS58NxtKvV97g7ypT6t-5dw__",
    "mime": "image/jpeg"
  }
}

Generated by aglio on 22 Mar 2026