For the complete documentation index, see llms.txt. This page is also available as Markdown.

Delete Sms Campaign

Deletes sms campaign from queue.

The SMS channel delivers text messages — templates, campaigns, and provider integrations — for OTPs, alerts, and bulk sends.

This endpoint removes the sms campaign. This action cannot be undone.

Deletes sms campaign from queue

delete
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters
Idstring · nullableRequired

The campaign id to delete. Get it from get_sms_campaigns.

DatabaseIntegrationIdstring · nullableOptional

Optional. Omit to use the project default database integration (resolved per environment).

Header parameters
norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses
200

OK

application/json
delete/{version}/notifications/sms/campaigns/{id}
DELETE /{version}/notifications/sms/campaigns/{id}?Id=text HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*
200

OK

{
  "responseStatus": {
    "isSuccess": true
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Notifications.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Delete Sms Campaign in the SDK reference, with examples in every language.

Last updated