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

Update Email Template

Update an email template.

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

This endpoint updates the email template — only the fields you send are changed.

Update an email template

put
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

Update an email template

viewIdstringRequired

The email template id to update. Get it from get_email_templates.

templateNamestringRequired

The display name of the email template.

descriptionstring · nullableOptional

Optional free-text description of what the template is used for.

communicationChannelstring · enumOptionalPossible values:
projectIdstringRequired

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

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
put/{version}/notifications/email/templates
PUT /{version}/notifications/email/templates HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 297

{
  "viewId": "text",
  "templateName": "text",
  "description": "text",
  "communicationChannel": "Transactional",
  "tags": null,
  "staticAttachments": null,
  "translations": null,
  "projectId": "text",
  "env": "text",
  "resolvedEnv": {
    "value": "text",
    "isProd": true
  },
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text"
}
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 Update Email Template in the SDK reference, with examples in every language.

Last updated