PUT /devices/actions/contactInfo
Changes the name and address associated with devices.
NOTE: This API is currently in limited release, and it must be enabled for your organization before you can use it. You can contact Customer Support or your Verizon Sales Representative to learn about enabling the API for your organization.
See Also
Activate Devices
Get Device Information
Change Device Cost Center
The existing Primary Place of Use values set for the devices are erased by this request and are replaced by the new values specified in the request. If you do not provide a value for a parameter, it is set to an empty string.
The M2M Platform sends a CarrierService callback message when the device contact information has been changed, or if there was a problem and the change could not be completed.
PUT https://thingspace.verizon.com/api/m2m/v1/devices/actions/contactInfo
None.
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
Parameter Name | Data Type | Description |
---|---|---|
Authorization required |
string | HTTP Authorization bearer token. |
VZ-M2M-Token required |
string | A valid session token returned by POST /session/login. |
Content-Type required |
string | Must be application/json . |
Select the devices to change:
Parameter Name | Data Type | Description |
---|---|---|
devices optional* |
array of deviceIds objects | A list of the devices that you want to change, specified by device identifier. You only need to provide one identifier per device. Do not include accountName, groupName, customFields, or servicePlan if you use this parameter. |
kind,
id required for devices |
string | The type and value of the device identifier.
|
accountName optional *Recommended |
string | The name of the billing account that the devices belong to. An account name is usually numeric, and must include any leading zeros. *By coding for the account number today, you prevent future code from breaking if you ever add a new sub-account. |
primaryPlaceOfUse required |
object | The customer name and the address of the device’s primary place of use. These values are applied to all devices in the request. The Primary Place of Use location may affect taxation or have other legal implications. You may want to speak with legal and/or financial advisers before entering values for these fields. |
customerName
required for primaryPlaceOfUse |
object | The customer name to be used for line usage taxation. |
title
optional |
string | An optional title for the customer, such as “Mr.” or “Dr.” |
firstName
required for customerName |
string | The customer’s first name. |
middleName
optional |
string | The customer’s middle name. |
lastName
required for customerName |
string | The customer’s last name. |
suffix
optional |
string | An optional suffix for the customer name, such as “Jr.” or “III.” |
address
required for primaryPlaceOfUse |
object | The customer address for the line’s primary place of use, for line usage taxation. |
addressLine1
required for address |
string | The street address for the line’s primary place of use. This must be a physical address for taxation; it cannot be a P.O. box. |
addressLine2
optional |
string | Optional additional street address information. |
city
required for address |
string | The city for the line’s primary place of use. |
state
required for address |
string | The state for the line’s primary place of use. |
zip
required for address |
string | The ZIP code for the line’s primary place of use. |
zip4
optional |
string | The ZIP+4 for the line’s primary place of use. |
country
required for address |
string | Either “US” or “USA” for the country of the line’s primary place of use. |
phone
optional |
string | A phone number where the customer can be reached. |
phoneType
optional |
string | A single letter to indicate the customer phone type:
|
emailAddress
optional |
string | An email address for the customer. |
Change the contact information for two devices
{
"devices":[
{
"deviceIds":[
{
"kind":"ESN",
"id":"19110173057"
},
{
"kind":"ESN",
"id":"19110173057"
}
]
}
],
"accountName":"0212345678-00001",
"primaryPlaceOfUse":{
"address":{
"addressLine1":"9868 Scranton Rd",
"addressLine2":"Suite A",
"city":"San Diego",
"state":"CA",
"country":"USA",
"zip":"92121",
"zip4":"0001",
"phone":"1234567890",
"phoneType":"H",
"emailAddress":"zaffod@theinternet.com"
},
"customerName":{
"firstName":"Zaffod",
"lastName":"Beeblebrox",
"middleName":"P",
"title":"President",
"suffix":"I"
}
}
}
Status 200
Parameter Name | Data Type | Description |
---|---|---|
requestId | string | A unique string that associates the request with the results that are sent via a callback service. The ThingSpace Platform sends a separate callback message for each device that matched the request criteria, indicating whether the operation succeeded for that device and containing any requested information. All of the callback messages have the same requestId. |
{
"requestId": "24da9f9a-d110-4a54-86b4-93fb76aab83c"
}
{
"username":"",
"password":"",
"requestId":"24da9f9a-d110-4a54-86b4-93fb76aab83c",
"deviceIds":[
{
"kind":"ESN",
"id":"19110173057"
},
{
"kind":"ESN",
"id":"19110173057"
}
],
"deviceResponse":{
"contactInfoResponse":{
"accountName":"0212345678-00001"
}
},
"status":"Success",
"callbackCount":1,
"maxCallbackThreshold":4
}
Status 400
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}
Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.