---
title: "Update SIM usage limits"
method: POST
path: "/devices/{deviceId}/usagelimit"
tags: ["SIMs (Devices)"]
---

# Update SIM usage limits

`POST /devices/{deviceId}/usagelimit`

## Request

- Base URL: `https://dashboard.hologram.io/api/1`
- URL: `https://dashboard.hologram.io/api/1/devices/{deviceId}/usagelimit`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/devices/:deviceId/usagelimit/post.ts> (a function with typed inputs; its response is checked against the schema)

Updates the data usage limit, SMS limit, and data warning threshold for a SIM using the device ID for the SIM. Values must be >= -1, where -1 means no limit.

Data usage limits are applied above the included data in the SIM's data plan; a 500 MB data plan with a 250 MB data limit will trigger an event when the SIM uses 750 MB of data.

SMS limits can be reduced, or raised back up to your organization's maximum SMS limit.

## Path parameters

- `deviceId` integer, required

## Request body

- union
  - object
    - `datathreshold` number, required: Data warning threshold in bytes; an event is created when data usage reaches this value (-1 for no limit)
    - `overagelimit` number: Additional bytes of data allowed above the plan's included data; SIM pauses when usage exceeds plan included data plus this value (-1 for unlimited, 0 for plan included data only)
    - `smslimit` number: Maximum number of SMS messages allowed, within the organization's SMS limit; SIM is paused when this limit is reached
  - object
    - `datathreshold` number: Data warning threshold in bytes; an event is created when data usage reaches this value (-1 for no limit)
    - `overagelimit` number, required: Additional bytes of data allowed above the plan's included data; SIM pauses when usage exceeds plan included data plus this value (-1 for unlimited, 0 for plan included data only)
    - `smslimit` number: Maximum number of SMS messages allowed, within the organization's SMS limit; SIM is paused when this limit is reached
  - object
    - `datathreshold` number: Data warning threshold in bytes; an event is created when data usage reaches this value (-1 for no limit)
    - `overagelimit` number: Additional bytes of data allowed above the plan's included data; SIM pauses when usage exceeds plan included data plus this value (-1 for unlimited, 0 for plan included data only)
    - `smslimit` number, required: Maximum number of SMS messages allowed, within the organization's SMS limit; SIM is paused when this limit is reached

## Response `200`

OK

- object
  - `success` boolean: Indicates whether the request was successful.
  - `data` object
    - `warnings` string[]
    - `devices_modified` integer[]: IDs of devices whose usage limit was updated
    - `profiles_modified` integer[]: IDs of SIM profiles whose usage limit was updated
    - `newdatathreshold` number: Updated data warning threshold in bytes (-1 for no threshold)
    - `newoveragelimit` number: Updated data overage limit in bytes above the plan's included data (-1 for unlimited)
    - `newsmslimit` number: Updated SMS limit

## Other responses

- `400`: Bad request
- `401`: Unauthorized

---

[API](https://skmtc.dev/hologram/apis/hologram-rest-api-v1.md) - [All operations](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/revisions/1bc07dcd1631?raw)