Update block attributes

PATCH /v1/pages/:pageId/blocks/:blockId/attrs

Changes the attributes of block nodes on a site page, for example the countdown end date of a timer block. Only attributes that the block manifest declares as editable can be changed.

Parameters

Parameter	Type	Required	Description
Parameter`pageId` (path)	Typenumber	Requiredyes	DescriptionPage ID. List: `GET /v1/pages`
Parameter`blockId` (path)	Typenumber	Requiredyes	DescriptionID of a block on this page. List: `GET /v1/pages/:pageId/blocks`
Parameter`scope` (query)	Typestring	Requiredno	DescriptionSite area: `KNOWLEDGE` — knowledge base, `GROUP` — workgroup pages, `MAINPAGE` — home pages. Omit the parameter for pages of all other sites

Request fields (body)

Field	Type	Required	Description
Field`attrs`	Typeobject	Requiredyes	DescriptionAn object of the form "selector → attributes". Must not be empty. The body has no other fields
Field`attrs.<selector>`	Typeobject	Requiredyes	DescriptionThe key is a node selector `.class` or `.class@N`, where `N` is a zero-based index among the nodes with that class. Without `@N`, the change applies to all nodes with that class. Only nodes for which the block manifest declares editable attributes are allowed. They are visible in the response of `GET /v1/pages/:pageId/blocks/:blockId/content`: elements with the `attribute` key in the `cards`, `style` and `attrs` fields, and for a timer block — `cards.<selector>.additional.attrs`. The value is a non-empty object of attributes
Field`attrs.<selector>.<attribute>`	Typestring	Requiredyes	DescriptionThe new attribute value. For a timer block, `data-end-date` is the countdown end time in milliseconds

Examples

curl — personal key

Terminal

curl -X PATCH "https://vibecode.bitrix24.com/v1/pages/42/blocks/7/attrs" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "attrs": {
      ".landing-block-node-card@0": {
        "data-end-date": "1798750800000"
      }
    }
  }'

curl — OAuth application

Terminal

curl -X PATCH "https://vibecode.bitrix24.com/v1/pages/42/blocks/7/attrs" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attrs": {
      ".landing-block-node-card@0": {
        "data-end-date": "1798750800000"
      }
    }
  }'

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/pages/42/blocks/7/attrs', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    attrs: {
      '.landing-block-node-card@0': {
        'data-end-date': '1798750800000',
      },
    },
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/pages/42/blocks/7/attrs', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    attrs: {
      '.landing-block-node-card@0': {
        'data-end-date': '1798750800000',
      },
    },
  }),
})

const { success, data } = await res.json()

Response fields

Field	Type	Description
Field`success`	Typeboolean	Description`true` on success
Field`data.id`	Typenumber	DescriptionBlock ID
Field`data.pageId`	Typenumber	DescriptionPage ID
Field`data.anchor`	Typestring	DescriptionBlock anchor. An automatic anchor has the form `b<id>`, for example `b7`
Field`data.content`	Typestring	DescriptionThe full block HTML, read back after the change
Field`data.nodes`	Typeobject	DescriptionEmpty object. The block state is in `content`
Field`data.styles`	Typeobject	DescriptionEmpty object. The block state is in `content`
Field`data.attrs`	Typeobject	DescriptionEmpty object. The block state is in `content`
Field`data.cards`	Typeobject	DescriptionEmpty object. The block state is in `content`
Field`data.active`	Typeboolean	DescriptionWhether the block is active

Response example

The timer block markup is long, so content is shortened: it shows the .landing-block-node-card node with the saved attribute, and the rest is replaced with an ellipsis.

JSON

{
  "success": true,
  "data": {
    "id": 7,
    "pageId": 42,
    "anchor": "b7",
    "content": "<div id=\"block7\" data-id=\"7\" class=\"block-wrapper block-51-4-countdown-music\">…<div class=\"landing-block-node-card row g-mb-50 js-countdown u-countdown\" data-end-date=\"1798750800000\" data-days-format=\"%D\" data-hours-format=\"%H\" data-minutes-format=\"%M\" data-seconds-format=\"%S\" data-days-expired-classes=\"u-countdown--days-expiried\">…</div>…</div>",
    "nodes": {},
    "styles": {},
    "attrs": {},
    "cards": {},
    "active": true
  }
}

Error response example

400 — the selector is not among the nodes with editable attributes; the message lists the available ones: