Skip to content

ItemShareChangeResponseDto

Endpoints · All schemas

FieldRequiredDescription
addedYesShares this change added
linkYesWhere recipients open what is shared with them: the Public server URL when set, otherwise the direct-connection address (or a custom hostname pointed at it); null when the server has no address
removedYesShares this change removed
sharesYesEvery share of these items after the change

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: ItemShareResponseDto

{
  "properties": {
    "added": {
      "description": "Shares this change added",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "link": {
      "description": "Where recipients open what is shared with them: the Public server URL when set, otherwise the direct-connection address (or a custom hostname pointed at it); null when the server has no address",
      "nullable": true,
      "type": "string"
    },
    "removed": {
      "description": "Shares this change removed",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "shares": {
      "description": "Every share of these items after the change",
      "items": {
        "$ref": "#/components/schemas/ItemShareResponseDto"
      },
      "type": "array"
    }
  },
  "required": [
    "added",
    "link",
    "removed",
    "shares"
  ],
  "type": "object"
}