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

update a page sharing state to enabled or disable public sharing

Path Params

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

Body Params

    • Name
      sharing
      Type
      object
      Description
      PublicShareUpdate is used to switch the public sharing on or off for an object.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
    • 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

    200 OK

    PublicShare
    {
      "sharing": {
        "createdAt": "2024-04-12T16:21:59.318Z",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "2024-04-12T16:21:59.318Z",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "id": 0,
        "page": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "scopes": [
          {
            "createdAt": "2024-04-12T16:21:59.318Z",
            "createdBy": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "deletedAt": "2024-04-12T16:21:59.318Z",
            "deletedBy": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "id": 0,
            "name": "string",
            "role": "read",
            "scopeType": "anyone",
            "sharingURL": "string",
            "state": "enabled",
            "token": "string",
            "updatedAt": "2024-04-12T16:21:59.318Z",
            "updatedBy": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        ],
        "state": "enabled",
        "updatedAt": "2024-04-12T16:21:59.318Z",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    }