Register a device for receiving push notifications

{
  "type": "object",
  "properties": {
    "clientId": {
      "type": "string",
      "description": "Optional trusted client identifier for the device."
    },
    "deviceSecret": {
      "type": "string",
      "description": "Secret value for the device."
    },
    "formFactor": {
      "type": "string",
      "description": "Form factor of the push device.",
      "enum": [
        "phone",
        "tablet",
        "desktop",
        "tv",
        "watch",
        "car",
        "embedded"
      ]
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for the device generated by the device itself."
    },
    "metadata": {
      "type": "object",
      "description": "Optional metadata object for this device. The metadata for a device may only be set by clients with push-admin privileges and will be used more extensively in the future with smart notifications."
    },
    "platform": {
      "type": "string",
      "description": "Platform of the push device.",
      "enum": [
        "ios",
        "android"
      ]
    },
    "push.recipient": {
      "type": "object",
      "description": "Push recipient details for a device.",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "Client ID of recipient"
        },
        "deviceId": {
          "type": "string",
          "description": "Client ID of recipient"
        },
        "deviceToken": {
          "type": "string",
          "description": "when using APNs, specifies the required device token."
        },
        "registrationToken": {
          "type": "string",
          "description": "when using GCM or FCM, specifies the required registration token."
        },
        "transportType": {
          "type": "string",
          "description": "Defines which push platform is being used.",
          "enum": [
            "apns",
            "fcm",
            "gcm"
          ]
        }
      }
    },
    "push.state": {
      "type": "string",
      "description": "the current state of the push device.",
      "enum": [
        "Active",
        "Failing",
        "Failed"
      ]
    }
  }
}