Device Management

Updates one or more custom field values for devices.

PUT
/m2m/v1/devices/actions/customFields

Sends a CarrierService callback message for each device in the request when the custom fields have been changed, or if there was a problem and the change could not be completed.

Authorization

thingspace_oauth VZ-M2M-Token
AuthorizationBearer <token>

This is the ThingSpace token, from Credentials and Tokens is used

In: header

VZ-M2M-Token<token>

M2M Session Token (How to generate an M2M session token?)

In: header

Request Body

application/json

Request to update custom field of devices.

Request to update custom field of devices.

accountName?string

The name of a billing account.This parameter is only required if the UWS account used for the current API session has access to multiple billing accounts.An account name is usually numeric, and must include any leading zeros.

customFields?array<>

Custom field names and values, if you want to only include devices that have matching values.

customFieldsToUpdate?array<>

The names and new values of any custom fields that you want to change.

devices?array<>

The devices that you want to change.

groupName?string

The name of a device group, if you want to only include devices in that group.

servicePlan?string

The name of a service plan, if you want to only include devices that have that service plan.

Response Body

application/json

application/json

curl -X PUT "https://example.com/m2m/v1/devices/actions/customFields" \  -H "Content-Type: application/json" \  -d '{    "devices": [      {        "deviceIds": [          {            "id": "89148000000800139708",            "kind": "iccid"          }        ]      }    ],    "customFieldsToUpdate": [      {        "key": "CustomField1",        "value": "West Region"      },      {        "key": "CustomField2",        "value": "Distribution"      }    ]  }'
{  "requestId": "595f5c44-c31c-4552-8670-020a1545a84d"}