Use this API if you want to manage some device settings before you are ready to activate service for the devices.
thingspace_oauth VZ-M2M-Token This is the ThingSpace token, from Credentials and Tokens is used
In: header
The VZ-M2M session token from Credentials and Tokens
In: header
application/json
Devices to add to the account.
TypeScript Definitions
Use the request body type in TypeScript.
Request to add the devices.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/devices/actions/add" \ -H "Content-Type: application/json" \ -d '{ "accountName": "0000123456-00001", "customFields": [ { "key": "CustomField2", "value": "SuperVend" } ], "devicesToAdd": [ { "deviceIds": [ { "kind": "imei", "id": "15-digit IMEI" }, { "kind": "iccid", "id": "20-digit ICCID" } ] }, { "deviceIds": [ { "kind": "imei", "id": "15-digit IMEI" }, { "kind": "iccid", "id": "20-digit ICCID" } ] } ], "groupName": "West Region", "state": "preactive" }'[ { "deviceIds": [ { "id": "20-digit ICCID", "kind": "iccid" } ], "response": "Success" }]{ "errorCode": "SessionService.REQUEST_FAILED.Login.Invalid", "errorMessage": "Username or Password is incorrect"}{ "fault": { "code": "900902", "message": "Missing Credentials\n", "description": "Required OAuth credentials not provided. Make sure your API invocation call has an Authorization header\n" }}{ "fault": { "code": "900903", "message": "Access Forbidden", "description": "You do not have permission to access the API: /m2m/v1, version: v1. Ensure your account has the necessary privileges." }}{ "fault": { "code": "900906", "message": "No matching resource found in the API for the given request\n", "description": "Access failure for API: /m2m/v1, version: v1. Check the API documentation and add a proper REST resource path to the invocation URL\n" }}{ "timestamp": "2025-09-17T17:49:18.676+00:00\n", "status": "405", "error": "Method Not Allowed", "path": "/m2m/v1/session/login"}{ "errorCode": "406 NotAcceptable", "errorMessage": "The requested resource is not available in a format acceptable to the client."}{ "errorCode": "429 TooManyRequests", "errorMessage": "Too many requests. Please try again later."}{ "errorCode": "500 InternalServerError", "errorMessage": "An unexpected error occurred on the server."}{ "errorCode": "SessionService.REQUEST_FAILED.Login.Invalid", "errorMessage": "Username or Password is incorrect"}The initial service state for the devices. The only valid state is "Preactive."
The devices that you want to add.
The numeric name of the account and must include leading zeroes.
The names and values for any custom fields that you want set for the devices as they are added to the account.
The name of a device group to add the devices to. They are added to the default device group if you don't include this parameter.
The Stock Keeping Unit (SKU) number of a 4G device type with an embedded SIM.
The Subscription Manager Secure Router Object ID, used for remote SIM provisioning. SMSR securely routes the download and management of eSIM profiles.
numberOfVirtualImei.
uploadType.