Create Sms Campaign

Create SMS campaign.

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

This endpoint creates the sms campaign and returns its id.

Create SMS campaign

post

Authorizations

Bearer

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

Body

multipart/form-dataapplication/json

Create SMS campaign

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

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

timeZoneIdstring · nullableOptional

TimeZone

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.

projectIdstringRequired

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

databaseIntegrationIdstring · nullableOptional

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

deliveryTypestring · enumOptionalPossible values:

initiatorIdstring · nullableOptional

languagestring · nullableOptional

Optional language code forcing one template translation for every recipient.

templateIdstringOptional

SMS template id to send — pick one with get_sms_templates. Never invent it.

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/notifications/sms/campaigns

HTTPcURLJavaScriptPython

POST /{version}/notifications/sms/campaigns HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 940

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "allUsers": {
    "campaignTime": 1,
    "mappedTokens": null,
    "recipientsSourceType": "AllUsers",
    "respectTimeZoneSettings": "1 (RespectToLastLoginZone)",
    "rolesNames": null,
    "userTags": null
  },
  "collection": {
    "campaignTime": 1,
    "mappedTokens": null,
    "recipientsSourceType": "AllUsers",
    "respectTimeZoneSettings": "1 (RespectToLastLoginZone)",
    "fields": null,
    "fieldType": "User",
    "languages": null,
    "roleNames": null,
    "schemaName": "text"
  },
  "databaseIntegrationId": "text",
  "deliveryType": "AllUsers",
  "initiatorId": "text",
  "language": "text",
  "phoneNumbers": {
    "campaignTime": 1,
    "mappedTokens": null,
    "recipientsSourceType": "AllUsers",
    "respectTimeZoneSettings": "1 (RespectToLastLoginZone)",
    "phoneNumbers": null
  },
  "specifiedUsers": {
    "campaignTime": 1,
    "mappedTokens": null,
    "recipientsSourceType": "AllUsers",
    "respectTimeZoneSettings": "1 (RespectToLastLoginZone)",
    "recipients": null
  },
  "templateId": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "id": "text",
  "status": "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 Create Sms Campaign in the SDK reference, with examples in every language.