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

# Update SIM data usage limits (batch)

`POST /devices/batch/usagelimit`

## Request

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

Create a batch job to update the usage limits for a large set of SIMs using the device ID for each SIM. Returns a list of tasks for the batch runner.

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.

## Request body

- union
  - object
    - `deviceids` integer[], required: List of device IDs to update
    - `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: SMS limit; SIM is paused when this limit is reached (-1 for no limit)
  - object
    - `deviceids` integer[], required: List of device IDs to update
    - `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: SMS limit; SIM is paused when this limit is reached (-1 for no limit)
  - object
    - `deviceids` integer[], required: List of device IDs to update
    - `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: SMS limit; SIM is paused when this limit is reached (-1 for no limit)

## Response `200`

OK

- BatchJobResponse
  - `success` boolean: Indicates whether the request was successful.
  - `data` object
    - `jobid` integer: ID of the created batch job
    - `preview` boolean: Whether this was a preview (dry-run) request
    - `valid_tasks` object[]: List of validated tasks queued in this job

## 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/69a5b58e05fb?raw)