Delete SMS campaign

DELETE/sms-campaigns/{id}

Permanently deletes an SMS campaign and, by cascade, its recipients. This cannot be undone. To stop sending without destroying the history, use POST /sms-campaigns/{id}/terminate instead.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Path parameters

idstringrequired
UUID of the resource.

Response 200 OK

Deletion result.

successbooleanrequired
terminatedbooleanoptional
True when a provider batch was terminated before deletion.
providerobjectoptional
Present only when terminated is true.
4 fields
- calledbooleanoptional
- usedstringnullableoptional
  Provider that handled the terminate-batch call.
- successbooleanoptional
- errorstringnullableoptional
  Provider error text when success is false; null otherwise.

Errors

401Unauthorized
Missing, malformed, or invalid API key.
403Forbidden
Workspace unavailable, suspended, or paywalled.
404Not Found
Resource not found in this workspace.
429Too Many Requests
Workspace request limit exceeded; shared across all its API keys.