Create Email Campaign

Create email campaign.

The Email channel handles transactional and campaign email — templates, footers, signatures, campaigns, and provider integrations.

This endpoint creates the email campaign and returns its id.

Create email campaign

post

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

Body

Create email 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

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/notifications/email/campaigns

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

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "campaign": {
    "source": "AllUsers",
    "templateId": "text",
    "integrationId": "text",
    "validationIntegrationId": "text",
    "language": "text",
    "initiatorId": "text",
    "notes": "text",
    "mappedTokens": null,
    "campaignTime": 1
  },
  "databaseIntegrationId": "text"
}

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