For AI agents: markdown of this page — /docs-content-en/entities/calendar-resources/update.md documentation index — /llms.txt

Rename calendar resource

PATCH /v1/calendar-resources/:id · Bitrix24 API: calendar.resource.update · Scope: calendar

Bitrix24 resets the resource access permissions to their default values when updating the resource.

Parameters

Parameter Type Required Description
id integer Yes Resource ID from resource list.
name string Yes New resource name; only this field is writable.

Examples

Terminal
curl -X PATCH "https://vibecode.bitrix24.com/v1/calendar-resources/7" -H "X-Api-Key: $VIBE_API_KEY" -H 'Content-Type: application/json' -d '{"name": "Meeting room renamed"}'
Terminal
curl -X PATCH "https://vibecode.bitrix24.com/v1/calendar-resources/7" -H "X-Api-Key: $VIBE_API_KEY" -H "Authorization: Bearer $VIBE_USER_TOKEN" -H 'Content-Type: application/json' -d '{"name": "Meeting room renamed"}'
javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/calendar-resources/7', {
  method: 'PATCH',
  headers: { 'X-Api-Key': apiKey, 'Content-Type': 'application/json' },
  body: JSON.stringify({"name": "Meeting room renamed"})
});
console.log(await response.json());
javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/calendar-resources/7', {
  method: 'PATCH',
  headers: { 'X-Api-Key': apiKey , 'Authorization': `Bearer ${userToken}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"name": "Meeting room renamed"})
});
console.log(await response.json());

Response

JSON
{
  "success": true,
  "data": {
    "id": 7,
    "name": "Meeting room renamed",
    "createdBy": 1
  }
}

Response fields

Field Type Description
success boolean True on success.
data object Fresh resource: id, name, createdBy.

Errors

HTTP Code Condition
400 INVALID_PARAMS Invalid IDs, dates or status.
400 MISSING_REQUIRED_FIELDS Required values are absent.
401 TOKEN_MISSING The key has no usable B24 credentials.
403 SCOPE_DENIED calendar scope is missing.
403 WRITE_BLOCKED_READONLY_KEY The key forbids a write.
403 BITRIX_ACCESS_DENIED Bitrix24 denied access.
404 ENTITY_NOT_FOUND Resource or event is absent.
422 BITRIX_ERROR B24 refused the operation or did not persist the write.
429 RATE_LIMITED Request limit exceeded.
502 BITRIX_UNAVAILABLE Invalid or unavailable B24 response.
503 BITRIX_TIMEOUT B24 timed out.

Invalid input returns an error instead of an empty result:

JSON
{"success":false,"error":{"code":"INVALID_PARAMS","message":"Invalid calendar parameters"}}

All errors

See also