POST/spaces/api/v1/spaces/{spaceID}/pages/{pageID}/shares/scopes.json

add one or many sharing scopes to a page

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Body Params

    • Name
      sharing
      Type
      array
      Description
      ScopeCreate is an individual createable scope - it is a stripped version of the main Scope object.

    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

    Examples

    201 Created

    Scope
    {
      "createdAt": "2024-07-22T17:44:54.321Z",
      "createdBy": {
        "id": 0,
        "meta": {},
        "type": "string"
      },
      "deletedAt": "2024-07-22T17:44:54.321Z",
      "deletedBy": {
        "id": 0,
        "meta": {},
        "type": "string"
      },
      "id": 0,
      "name": "string",
      "role": "read",
      "scopeType": "anyone",
      "sharingURL": "string",
      "state": "enabled",
      "token": "string",
      "updatedAt": "2024-07-22T17:44:54.321Z",
      "updatedBy": {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    }