Get Sms Campaign

Get sms campaign by id.

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

This endpoint returns a single sms campaign by id.

Get sms campaign by id

get

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 · nullableOptional

The campaign id.

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

get/{version}/notifications/sms/campaigns/{id}

GET /{version}/notifications/sms/campaigns/{id} HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "smsCampaign": {
    "viewId": "text",
    "createdOn": "text",
    "language": "text",
    "forceCampaignLanguage": true,
    "campaignProcessingIntegrationId": "text",
    "statusHistory": [],
    "tokenMappingValues": [],
    "notes": "text",
    "userId": "text",
    "id": "text"
  }
}

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 Get Sms Campaign in the SDK reference, with examples in every language.