---
title: "Get an SMS template's usage"
description: "What uses an SMS template, and whether a change would be accepted now: its live campaigns and automations, queued texts, and can_edit_content / can_unpublish with the reason when not. `GET /api/v1/sms/templates/{id}/usage`"
url: https://www.unitpost.com/docs/sms/get-sms-templates-id-usage
section: "SMS API reference"
updated: 2026-10-13
---
# Get an SMS template's usage

`GET /api/v1/sms/templates/{id}/usage`

What uses an SMS template, and whether a change would be accepted now: its live campaigns and automations, queued texts, and `can_edit_content` / `can_unpublish` with the reason when not. Read it before an edit or delete. Requires the `templates:read` capability.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | — |

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `template_id` | string | yes | — |
| `live_campaigns` | object[] | yes | — |
| `live_automations` | object[] | yes | — |
| `pending_sends` | integer | yes | — |
| `system_locked` | boolean | yes | — |
| `can_edit_content` | boolean | yes | — |
| `content_blocked_reason` | string \| null | yes | — |
| `can_unpublish` | boolean | yes | — |
| `unpublish_blocked_reason` | string \| null | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | Its usage. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope. |
| 404 | SMS template not found, or SMS is not enabled. |
| 422 | A query key (this operation takes none). |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/sms/templates/tmpl_123/usage' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "object": "sms_template_usage",
  "template_id": "template_123",
  "live_campaigns": [
    {
      "id": "id_123",
      "name": "Example",
      "status": "queued"
    }
  ],
  "live_automations": [
    {
      "id": "id_123",
      "name": "Example",
      "status": "queued"
    }
  ],
  "pending_sends": 0,
  "system_locked": false,
  "can_edit_content": false,
  "content_blocked_reason": "string",
  "can_unpublish": false,
  "unpublish_blocked_reason": "string"
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/sms/get-sms-templates-id-usage
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json