NumbersPost

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NumbersPost",
  "title": "NumbersPost",
  "type": "object",
  "required": [
    "phoneNumbers"
  ],
  "properties": {
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of phone numbers that need to be added."
    },
    "numberType": {
      "$ref": "#/components/schemas/NumberTypeOptions",
      "description": "The type of the number. Required for `MOBILE` number type."
    },
    "numberUsageType": {
      "$ref": "#/components/schemas/NumberUsageTypeOptions",
      "description": "The type of usage expected for the number."
    },
    "state": {
      "$ref": "#/components/schemas/NumberStateOptions",
      "description": "The state of the number. By default, the state of a number is set to `ACTIVE` for DID and toll-free numbers only. Mobile numbers will be activated upon assignment to a user."
    },
    "subscriptionId": {
      "type": "string",
      "description": "The `subscriptionId` to be used for the mobile number order."
    },
    "carrierId": {
      "type": "string",
      "format": "uuid",
      "description": "The `carrierId` to be used for the mobile number order."
    }
  }
}