PutMemberObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutMemberObject",
  "title": "PutMemberObject",
  "type": "object",
  "required": [
    "port",
    "id",
    "primaryOwner",
    "lineType",
    "lineWeight",
    "hotlineEnabled",
    "hotlineDestination",
    "allowCallDeclineEnabled"
  ],
  "properties": {
    "port": {
      "type": "number",
      "example": 1,
      "description": "Person's assigned port number."
    },
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
      "description": "Unique identifier for the member."
    },
    "t38FaxCompressionEnabled": {
      "type": "boolean",
      "description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
    },
    "primaryOwner": {
      "type": "boolean",
      "example": true,
      "description": "Whether the user is the owner of the device or not, and points to a primary Line/Port of device."
    },
    "lineType": {
      "$ref": "#/components/schemas/LineType",
      "description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
    },
    "lineWeight": {
      "type": "number",
      "example": 1,
      "description": "Number of lines that have been configured for the person on the device."
    },
    "hotlineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
    },
    "hotlineDestination": {
      "type": "string",
      "example": "+12055552222",
      "description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
    },
    "allowCallDeclineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
    },
    "lineLabel": {
      "type": "string",
      "example": "share line label",
      "description": "Device line label."
    }
  }
}