Changes the provisioning state of one or more devices to a specified customer-defined service and state.
thingspace_oauth VZ-M2M-Token In: header
M2M Session Token (How to generate an M2M session token?)
In: header
application/json
Request to change device state to one defined by the user.
TypeScript Definitions
Use the request body type in TypeScript.
Changes the provisioning state of one or more devices to a specified customer-defined service and state.
application/json
application/json
curl -X PUT "https://example.com/m2m/v1/devices/actions/gotostate" \ -H "Content-Type: application/json" \ -d '{ "devices": [ { "deviceIds": [ { "kind": "imei", "id": "15-digit IMEI" }, { "kind": "iccid", "id": "20-digit ICCID" } ], "ipAddress": "10.0.0.1" }, { "deviceIds": [ { "kind": "imei", "id": "15-digit IMEI" }, { "kind": "iccid", "id": "20-digit ICCID" } ], "ipAddress": "127.0.0.1" } ], "serviceName": "user defined name of service", "stateName": "user defined state of device", "servicePlan": "service plan ID", "mdnZipCode": "20500", "carrierIpPoolName": "name of the IP pool", "skuNumber": "Stock Keeping Unit number", "customFields": [ { "key": "customFeild2", "value": "key value" } ], "groupName": "4G West", "publicIpRestriction": "U", "primaryPlaceOfUse": { "customerName": { "title": "President", "firstName": "Zaffod", "lastName": "Beeblebrox" }, "address": { "addressLine1": "1600 Pennsylvania Ave NW", "city": "Washington", "state": "DC", "zip": "20500", "country": "USA" } } }'{ "requestId": "595f5c44-c31c-4552-8670-020a1545a84d"}{ "errorCode": "error code string", "errorMessage": "error message string"}The name of a customer-defined service to push the devices to.
The name of a customer-defined stage state to push the devices to.
The service plan code that you want to assign to all specified devices in the new state.
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.
Up to 10,000 devices that you want to push to a different state, specified by device identifier.
Specify the kind of the device identifier, the type of match, and the string that you want to match.
The pool from which your device IP addresses will be derived if the service or state change requires new IP addresses.If you do not include this element, the default pool will be used.
For devices with static IP addresses on the public network, this specifies whether the devices have general access to the Internet. Valid values are “restricted” or “unrestricted”.
The Stock Keeping Unit (SKU) number of a 4G device type with an embedded SIM. Can be used with ICCID or EID 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.
The names and values of any custom fields that you want to set for the devices.
This is an array that associates an IP address with a device identifier. This variable is only relevant for Business Internet/Fixed Wireless Access
The IP address of the device.
The name of a device group that the devices should be added to.
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.