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: 07cac1ea-b6de-4e2f-80b0-2fd7a8d23cce
Request
HideShow
Body
{
  "title": "title",
  "content": "content",
  "parent": null
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
    "type": "page",
    "created_at": 1770151207.813204,
    "updated_at": 1770151207.816699,
    "parent": null,
    "created_by": "a432843f-4602-4d3e-9b20-e01c9aac18fc",
    "title": "title",
    "content": "content",
    "page_id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
    "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: 07cac1ea-b6de-4e2f-80b0-2fd7a8d23cce
id
string (required) Example: 8c3adcb6-148d-4eb0-a1eb-5df073339b42
Request
HideShow
Body
{
  "title": "title",
  "content": "content"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
    "type": "page",
    "created_at": 1770151207.813204,
    "updated_at": 1770151208.278237,
    "parent": null,
    "created_by": "a432843f-4602-4d3e-9b20-e01c9aac18fc",
    "title": "title",
    "content": "content",
    "page_id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
    "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: 07cac1ea-b6de-4e2f-80b0-2fd7a8d23cce
id
string (required) Example: 8c3adcb6-148d-4eb0-a1eb-5df073339b42
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: 07cac1ea-b6de-4e2f-80b0-2fd7a8d23cce
associations
string (required) Example: page.children,page.attachments
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
      "type": "page",
      "created_at": 1770151207.813204,
      "updated_at": 1770151208.278237,
      "parent": null,
      "created_by": "a432843f-4602-4d3e-9b20-e01c9aac18fc",
      "title": "title",
      "content": "content",
      "children": null,
      "attachments": [
        {
          "id": "2ca2ad74-3d84-4961-aaa0-1d8860a8cf0a",
          "created_at": 1770151208.567207,
          "updated_at": 1770151208.567207,
          "deleted_at": null,
          "created_by": "a432843f-4602-4d3e-9b20-e01c9aac18fc",
          "path": "pages/8c3adcb6-148d-4eb0-a1eb-5df073339b42/attachments/875b5340-0140-11f1-bb7b-c1ce1696c2c7.jpg",
          "name": "sample.jpg",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/pages/8c3adcb6-148d-4eb0-a1eb-5df073339b42/attachments/875b5340-0140-11f1-bb7b-c1ce1696c2c7.jpg?Expires=1770237608570&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QFMyckN2k~Ec02vuhKt8Xscrb7jJw7NuqJ2erTVIJljj3hTZ4MFO~Oa6tmDl55-DhIif5eBcRsOPFV1DL6mpgNbVMUSbf50sVCpZV9nOmokv3p6dBQAQRfxQoL6TJ-~5iEU9kBLDkF54OJDWLukj3a3viiADIrfOeaoqJ7glaF7SZYyqX~FoQdGCbFmUKpLeObUsxwqhbSEMzrQD-vvRhSznzj8Oe~6mrM13ClBRPqOECFHCYxGK2Xz4VFP879-7qaUos3M0WhsVyZYuHB3alptyBEQhqeIpl0xXk7sMn3SwutNXjMv6jlcpj8qL7GzpXaiKIsS-b-PdxP~B1IpQVA__",
          "preview_url": "https://private-cdn.irish.rechat.com/pages/8c3adcb6-148d-4eb0-a1eb-5df073339b42/attachments/875b5340-0140-11f1-bb7b-c1ce1696c2c7.jpg?Expires=1770237608570&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QFMyckN2k~Ec02vuhKt8Xscrb7jJw7NuqJ2erTVIJljj3hTZ4MFO~Oa6tmDl55-DhIif5eBcRsOPFV1DL6mpgNbVMUSbf50sVCpZV9nOmokv3p6dBQAQRfxQoL6TJ-~5iEU9kBLDkF54OJDWLukj3a3viiADIrfOeaoqJ7glaF7SZYyqX~FoQdGCbFmUKpLeObUsxwqhbSEMzrQD-vvRhSznzj8Oe~6mrM13ClBRPqOECFHCYxGK2Xz4VFP879-7qaUos3M0WhsVyZYuHB3alptyBEQhqeIpl0xXk7sMn3SwutNXjMv6jlcpj8qL7GzpXaiKIsS-b-PdxP~B1IpQVA__",
          "mime": "image/jpeg"
        }
      ],
      "page_id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
      "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: 07cac1ea-b6de-4e2f-80b0-2fd7a8d23cce
id
string (required) Example: 8c3adcb6-148d-4eb0-a1eb-5df073339b42
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
    "type": "page",
    "created_at": 1770151207.813204,
    "updated_at": 1770151208.278237,
    "parent": null,
    "created_by": "a432843f-4602-4d3e-9b20-e01c9aac18fc",
    "title": "title",
    "content": "content",
    "page_id": "8c3adcb6-148d-4eb0-a1eb-5df073339b42",
    "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: 07cac1ea-b6de-4e2f-80b0-2fd7a8d23cce
id
string (required) Example: 8c3adcb6-148d-4eb0-a1eb-5df073339b42
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "2ca2ad74-3d84-4961-aaa0-1d8860a8cf0a",
    "created_at": 1770151208.567207,
    "updated_at": 1770151208.567207,
    "deleted_at": null,
    "created_by": "a432843f-4602-4d3e-9b20-e01c9aac18fc",
    "path": "pages/8c3adcb6-148d-4eb0-a1eb-5df073339b42/attachments/875b5340-0140-11f1-bb7b-c1ce1696c2c7.jpg",
    "name": "sample.jpg",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/pages/8c3adcb6-148d-4eb0-a1eb-5df073339b42/attachments/875b5340-0140-11f1-bb7b-c1ce1696c2c7.jpg?Expires=1770237608570&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QFMyckN2k~Ec02vuhKt8Xscrb7jJw7NuqJ2erTVIJljj3hTZ4MFO~Oa6tmDl55-DhIif5eBcRsOPFV1DL6mpgNbVMUSbf50sVCpZV9nOmokv3p6dBQAQRfxQoL6TJ-~5iEU9kBLDkF54OJDWLukj3a3viiADIrfOeaoqJ7glaF7SZYyqX~FoQdGCbFmUKpLeObUsxwqhbSEMzrQD-vvRhSznzj8Oe~6mrM13ClBRPqOECFHCYxGK2Xz4VFP879-7qaUos3M0WhsVyZYuHB3alptyBEQhqeIpl0xXk7sMn3SwutNXjMv6jlcpj8qL7GzpXaiKIsS-b-PdxP~B1IpQVA__",
    "preview_url": "https://private-cdn.irish.rechat.com/pages/8c3adcb6-148d-4eb0-a1eb-5df073339b42/attachments/875b5340-0140-11f1-bb7b-c1ce1696c2c7.jpg?Expires=1770237608570&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QFMyckN2k~Ec02vuhKt8Xscrb7jJw7NuqJ2erTVIJljj3hTZ4MFO~Oa6tmDl55-DhIif5eBcRsOPFV1DL6mpgNbVMUSbf50sVCpZV9nOmokv3p6dBQAQRfxQoL6TJ-~5iEU9kBLDkF54OJDWLukj3a3viiADIrfOeaoqJ7glaF7SZYyqX~FoQdGCbFmUKpLeObUsxwqhbSEMzrQD-vvRhSznzj8Oe~6mrM13ClBRPqOECFHCYxGK2Xz4VFP879-7qaUos3M0WhsVyZYuHB3alptyBEQhqeIpl0xXk7sMn3SwutNXjMv6jlcpj8qL7GzpXaiKIsS-b-PdxP~B1IpQVA__",
    "mime": "image/jpeg"
  }
}

Generated by aglio on 03 Feb 2026