CarrierActivateRequest
Request for carrier activation.
CarrierActivateRequest
Request for carrier activation.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
devices | array | Yes | Up to 10,000 devices for which you want to activate service, specified by device identifier. |
servicePlan | string | Yes | The service plan code that you want to assign to all specified devices. |
mdnZipCode | string | Yes | The Zip code of the location where the line of service will primarily be used, or a Zip code that you have been told to use with these devices. For accounts that are configured for geographic numbering, this is the ZIP code from which the MDN will be derived. |
accountName | string | No | The name of a billing account. |
carrierIpPoolName | string | No | The private IP pool (Carrier Group Name) from which your device IP addresses will be derived. |
carrierName | string | No | The carrier that will perform the activation. |
costCenterCode | string | No | A string to identify the cost center that the device is associated with. |
customFields | array | No | A user-defined descriptive field, limited to 50 characters. |
groupName | string | No | If you specify devices by ID in the devices parameters, this is the name of a device group that the devices should be added to.If you don't specify individual devices with the devices parameter, you can provide the name of a device group to activate all devices in that group. |
leadId | string | No | The ID of a “Qualified” or “Closed - Won” VPP customer lead, which is used with other values to determine MDN assignment, taxation, and compensation. |
primaryPlaceOfUse | object | No | The customer name and the address of the device's primary place of use. Leave these fields empty to use the account profile address as the primary place of use. These values will be applied to all devices in the request.If the account is enabled for non-geographic MDNs and the device supports it, the primaryPlaceOfUse address will also be used to derive the MDN for the device. |
publicIpRestriction | string | No | For devices with static IP addresses on the public network, this specifies whether the devices have general access to the Internet. |
skuNumber | string | No | The Stock Keeping Unit (SKU) of a 4G device type can be used with ICCID device identifiers in lieu of an IMEI when activating 4G devices. The SkuNumber will be used with all devices in the request, so all devices must be of the same type. |