Docmost Octri Preview
POST/pages/add-permission

Grant users or groups access to a restricted page

Grants users or groups access to a restricted page. Supply pageId, a role, and at least one non-empty userIds or groupIds array; each array can contain at most 25 UUIDs.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Page access grant details. Include at least one non-empty userIds or groupIds array.

groupIdsarray<string>optional
UUIDs of the groups to grant access to. Supply no more than 25 IDs.
pageIdstringrequired
Page identifier.
rolestringrequired
The access role to grant: `reader` or `writer`.
Allowed:readerwriter
userIdsarray<string>optional
UUIDs of the users to grant access to. Supply no more than 25 IDs.

3 status codes
200Returns a successful response confirming that the permissions were granted.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when neither `userIds` nor `groupIds` is supplied as a non-empty array.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user is forbidden from granting access or page permissions are not included in the current licence.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned if userIds and groupIds are both missing or empty. A 403 is returned when the authenticated user is forbidden from granting access or page permissions are not included in the current licence. pageId and role are required, and role must be reader or writer; each supplied ID must be a UUID, with no more than 25 IDs per array.