PATCH/spaces/api/v1/spaces/{spaceID}/pages/{pageID}/shares/scopes/{scopeID}.json
update the properties of a scope.
Path Params
- Name
spaceID
- Type
- integer
- required
- Description
- Name
scopeID
- Type
- integer
- required
- Description
- Name
pageID
- Type
- integer
- required
- Description
Body Params
- Name
sharing
- Type
- object
- Description
- ScopeUpdate allows an individual scope to be updated. This exposes only updateable fields. Anything else submitted is ignored.
Responses
- Code
- 201
- Type
- object
- Schema
- Description
- 201 Created
Scope defines a single access level.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
- Code
- 404
- Type
- object
- Schema
- Description
- 404 Not Found
- Code
- 500
- Type
- object
- Schema
- Description
- 500 Internal Server Error
201 Created
Scope
{
"createdAt": "2024-10-10T18:19:43.436Z",
"createdBy": {
"id": 0,
"meta": {},
"type": "string"
},
"deletedAt": "2024-10-10T18:19:43.436Z",
"deletedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"id": 0,
"name": "string",
"role": "read",
"scopeType": "anyone",
"sharingURL": "string",
"state": "enabled",
"token": "string",
"updatedAt": "2024-10-10T18:19:43.436Z",
"updatedBy": {
"id": 0,
"meta": {},
"type": "string"
}
}