Skip to main content
POST
/
devices
/
changeplan
Change data plan for devices (bulk)
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/changeplan \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceids": [
    123
  ],
  "planid": 4,
  "zone": "global",
  "orgid": 45,
  "overage_limit": 123,
  "useacctbalance": true
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

​
preview
boolean

If true, simulate the operation without making changes

Body

application/json
​
deviceids
integer[]
required

List of device IDs to change plans for

​
planid
integer
required

ID of the data plan to assign

Example:

4

​
zone
string
required

Geographic zone for the plan

Example:

"global"

​
orgid
integer
required

Organization ID of the devices to change plans for

Example:

45

​
overage_limit
integer

Data overage limit in bytes. -1 for unlimited.

​
useacctbalance
boolean

Apply account balance credit to this order

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true