CommunicationTemplate | Subrite

CommunicationTemplate

Endpoints for CommunicationTemplate

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/communication-template

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of CommunicationTemplate

12 top-level fieldsSelect an object to expand

namestringRequired when parent is present
templateTypestringRequired when parent is present
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
communicationChannelstringRequired when parent is present
Allowed values: "sms", "email"
localestringRequired when parent is present
Allowed values: "en", "no", "sv", "da"
template

Schema Examplearray of CommunicationTemplate

200 · application/json

[
  {
    "name": "string",
    "templateType": "automation",
    "communicationChannel": "sms",
    "locale": "en",
    "template": "string",
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all communication template (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communication-template \
  --header 'Authorization: Bearer <token>'

Try it

Create communication template#

POST/api/v1/communication-template

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCommunicationTemplateDto

5 top-level fields

namestringRequired
templateTypestringRequired
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"

Compile a draft template to preview HTML#

POST/api/v1/communication-template/preview

Compiles MJML to the HTML an email would use, without saving anything. Returns partial HTML alongside any validation errors so an editor can preview a template while it is still being written.

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCommunicationTemplatePreviewDto

3 top-level fields

templatestringRequired
MJML source to compile. Not persisted.maxLength: 100000
localestring

Write a template from a description#

POST/api/v1/communication-template/generate

Returns MJML for a template described in plain language. Answers with the model's template or with an error — never a substitute, since the caller's editor holds the author's own markup. A tenant on the EU residency default has no model available and is refused.

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCommunicationTemplateGenerateDto

5 top-level fields

promptstringRequired
Plain-language description of the template to write.maxLength: 2000

GET/api/v1/communication-template/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleCommunicationTemplate

Same fields as Create communication template (201).

PATCH/api/v1/communication-template/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleCommunicationTemplateDto

Same fields as Create communication template (Request body).

Schema ExampleCommunicationTemplateDto

GET/api/v1/communication-template/{communicationChannel}/{templateType}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

communicationChannelstringRequired
templateTypestringRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

string

tenantTenantRequired when parent is present65 fields

[].tenant

marketstringRequired when parent is presentField path: [].tenant.market
Operating market of the tenant (immutable post-install).Allowed values: "NO", "SE", "DK"
productNamestringField path: [].tenant.productName
The product name of the tenantAllowed values: "enterprise", "communication", "custom"
additionalFeaturesarray of stringField path: [].tenant.additionalFeatures
Field details
The additional features of the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting", "invoices", "ai"
disabledFeaturesarray of stringField path: [].tenant.disabledFeatures
Field details
The disabled features of the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting", "invoices", "ai"
namestringRequired when parent is presentField path: [].tenant.name
isActivebooleanRequired when parent is presentField path: [].tenant.isActive
defaultLanguagestringRequired when parent is presentField path: [].tenant.defaultLanguage
Allowed values: "en", "no", "sv", "da"
hostNamestringRequired when parent is presentField path: [].tenant.hostName
logostringRequired when parent is presentField path: [].tenant.logo
faviconstringRequired when parent is presentField path: [].tenant.favicon
authLogostringRequired when parent is presentField path: [].tenant.authLogo
authLogoHeightnumberRequired when parent is presentField path: [].tenant.authLogoHeight
siteUrlstringRequired when parent is presentField path: [].tenant.siteUrl
termsUrlstringRequired when parent is presentField path: [].tenant.termsUrl
privacyUrlstringRequired when parent is presentField path: [].tenant.privacyUrl
gtmstringRequired when parent is presentField path: [].tenant.gtm
taxRatesarray of numberField path: [].tenant.taxRates
smsOtpbooleanRequired when parent is presentField path: [].tenant.smsOtp
emailProviderstringRequired when parent is presentField path: [].tenant.emailProvider
Allowed values: "brevo", "sendgrid"
tenantContactstringRequired when parent is presentField path: [].tenant.tenantContact
registeredBusinessNostringRequired when parent is presentField path: [].tenant.registeredBusinessNo
bankAccountNostringRequired when parent is presentField path: [].tenant.bankAccountNo
swiftCodestringRequired when parent is presentField path: [].tenant.swiftCode
ibanstringRequired when parent is presentField path: [].tenant.iban
defaultLogoutURLstringRequired when parent is presentField path: [].tenant.defaultLogoutURL
postalAddressstringRequired when parent is presentField path: [].tenant.postalAddress
otpTemplateIdTranslationField path: [].tenant.otpTemplateIdNested fields omitted: field limit.
smsSenderIdnumberRequired when parent is presentField path: [].tenant.smsSenderId
emailSenderIdnumberRequired when parent is presentField path: [].tenant.emailSenderId
smsSenderCommunicationSenderRequired when parent is presentField path: [].tenant.smsSenderNested fields omitted: field limit.
emailSenderCommunicationSenderRequired when parent is presentField path: [].tenant.emailSenderNested fields omitted: field limit.
productsarray of ProductRequired when parent is presentField path: [].tenant.productsNested fields omitted: field limit.
usersarray of UserRequired when parent is presentField path: [].tenant.usersNested fields omitted: field limit.
membersarray of MemberRequired when parent is presentField path: [].tenant.membersNested fields omitted: field limit.
rolesarray of RoleRequired when parent is presentField path: [].tenant.rolesNested fields omitted: field limit.
subscriptionPlansarray of SubscriptionPlanRequired when parent is presentField path: [].tenant.subscriptionPlansNested fields omitted: field limit.
packagesarray of PackageRequired when parent is presentField path: [].tenant.packagesNested fields omitted: field limit.
invoicesarray of InvoiceRequired when parent is presentField path: [].tenant.invoicesNested fields omitted: field limit.
ordersarray of OrderRequired when parent is presentField path: [].tenant.ordersNested fields omitted: field limit.
paymentProvidersarray of PaymentProviderConfigRequired when parent is presentField path: [].tenant.paymentProvidersNested fields omitted: field limit.
newslettersProviderConfigarray of NewsletterProviderConfigRequired when parent is presentField path: [].tenant.newslettersProviderConfigNested fields omitted: field limit.
paymentProviderConfigsarray of PaymentProviderConfigRequired when parent is presentField path: [].tenant.paymentProviderConfigsNested fields omitted: field limit.
oidcClientsarray of OidcClientRequired when parent is presentField path: [].tenant.oidcClientsNested fields omitted: field limit.
oauthProvidersarray of OauthProviderRequired when parent is presentField path: [].tenant.oauthProvidersNested fields omitted: field limit.
activityLogsarray of ActivityLogRequired when parent is presentField path: [].tenant.activityLogsNested fields omitted: field limit.
m2m_api_clientsarray of M2MApiClientRequired when parent is presentField path: [].tenant.m2m_api_clientsNested fields omitted: field limit.
customPropertiesarray of CustomPropertyRequired when parent is presentField path: [].tenant.customPropertiesNested fields omitted: field limit.
consentsarray of ConsentRequired when parent is presentField path: [].tenant.consentsNested fields omitted: field limit.
preferencePreferenceRequired when parent is presentField path: [].tenant.preferenceNested fields omitted: field limit.
settingsTenantSettingsRequired when parent is presentField path: [].tenant.settingsNested fields omitted: field limit.
communicationTemplatesarray of CommunicationTemplateRequired when parent is presentField path: [].tenant.communicationTemplatesRecursive schema; nested fields are not repeated.
additionalHostnamesarray of TenantHostnameRequired when parent is presentField path: [].tenant.additionalHostnamesNested fields omitted: field limit.
exportHistoryarray of ExportHistoryRequired when parent is presentField path: [].tenant.exportHistoryNested fields omitted: field limit.
arReportHistoryarray of ArReportHistoryRequired when parent is presentField path: [].tenant.arReportHistoryNested fields omitted: field limit.
mypageCardsSettingsarray of MypageCardsSettingsRequired when parent is presentField path: [].tenant.mypageCardsSettingsNested fields omitted: field limit.
webhooksarray of WebhookRequired when parent is presentField path: [].tenant.webhooksNested fields omitted: field limit.
customOrdersarray of CustomOrderRequired when parent is presentField path: [].tenant.customOrdersNested fields omitted: field limit.
customOrderSourcesarray of CustomOrderSourceRequired when parent is presentField path: [].tenant.customOrderSourcesNested fields omitted: field limit.
brandKitsarray of BrandKitRequired when parent is presentField path: [].tenant.brandKitsNested fields omitted: field limit.
communicationReceiversarray of CommunicationReceiverRequired when parent is presentField path: [].tenant.communicationReceiversNested fields omitted: field limit.
idnumberRequired when parent is presentField path: [].tenant.id
createdAtstring (date-time)Required when parent is presentField path: [].tenant.createdAt
updatedAtstring (date-time)Required when parent is presentField path: [].tenant.updatedAt
deletedAtstring (date-time)Required when parent is presentField path: [].tenant.deletedAt
metaDataobjectRequired when parent is presentField path: [].tenant.metaData

Schema ExampleCommunicationTemplateDto

application/json

{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string"
}

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleCommunicationTemplate

12 top-level fieldsSelect an object to expand

namestringRequired
templateTypestringRequired
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
communicationChannelstringRequired
Allowed values: "sms", "email"
localestringRequired
Allowed values: "en", "no", "sv", "da"
templatestringRequired
tenantIdnumberRequired
tenantTenantRequired65 fields
tenant
- marketstringRequiredField path: tenant.market
  Operating market of the tenant (immutable post-install).Allowed values: "NO", "SE", "DK"
- productNamestringField path: tenant.productName
  The product name of the tenantAllowed values: "enterprise", "communication", "custom"
- additionalFeaturesarray of stringField path: tenant.additionalFeatures
  Field details
  The additional features of the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting"
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

77 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleCommunicationTemplate

201 · application/json

Responses 400

Status201 400 401 403 500application/json

invalidMjmlFormat

Schema ExampleErrorResponse

Same fields as Get all communication template (403).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get all communication template (403).

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all communication template (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communication-template \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string"
}'

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleCommunicationTemplatePreviewResponseDto

4 top-level fieldsSelect an object to expand

htmlstringRequired
Compiled email HTML. Partial when the template has errors, empty when it cannot compile at all.
errorsarray of MjmlValidationErrorDtoRequired3 fields
errors
- linenumberRequired when parent is presentField path: errors[].line
  1-based line in the MJML source, 0 when not attributable.
- messagestringRequired when parent is presentField path: errors[].message
- tagNamestringRequired when parent is presentField path: errors[].tagName
  Offending MJML tag, empty when not tied to one.
sectionsnumberRequired
Number of mj-section elements, for the editor status line.
previewTextstringRequired
Can be nullContents of mj-preview, or null when the template declares none.

7 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleCommunicationTemplatePreviewResponseDto

201 · application/json

{
  "html": "string",
  "errors": [
    {}
  ],
  "sections": 0,
  "previewText": "string"
}

Example · 8 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all communication template (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all communication template (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communication-template/preview \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "template": "string",
  "locale": "en",
  "sampleData": true
}'

templateType

string

Schema ExampleCommunicationTemplateGenerateDto

application/json

{
  "prompt": "string",
  "templateType": "automation",
  "locale": "en",
  "currentTemplate": "string",
  "conversationId": "string"
}

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 422 500application/json

Schema ExampleCommunicationTemplateGenerateResponseDto

2 top-level fields

templatestringRequired
MJML for the generated template.
conversationIdstringRequired
The editing session this call was attributed to. Send it back with the next prompt so the whole session groups into one entry in the AI usage ledger.

2 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleCommunicationTemplateGenerateResponseDto

201 · application/json

{
  "template": "string",
  "conversationId": "string"
}

Example · 4 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 422 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Compile a draft template to preview HTML (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 422 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all communication template (403).

Schema ExampleErrorResponse

403 · application/json

Responses 422

Status201 400 401 403 422 500application/json

emailTemplateGenerationFailed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "emailTemplateGenerationFailed"
messagestring

Responses 500

Status201 400 401 403 422 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all communication template (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communication-template/generate \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prompt": "string",
  "templateType": "automation",
  "locale": "en",
  "currentTemplate": "string",
  "conversationId": "string"
}'

200 · application/json

{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string",
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 93 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all communication template (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string"
}

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleCommunicationTemplate

Same fields as Create communication template (201).

Schema ExampleCommunicationTemplate

200 · application/json

{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string",
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 93 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

invalidMjmlFormat

Schema ExampleErrorResponse

Same fields as Get all communication template (403).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get all communication template (403).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all communication template (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communication-template/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string"
}'

Schema Examplearray of CommunicationTemplate

200 · application/json

[
  {
    "name": "string",
    "templateType": "automation",
    "communicationChannel": "sms",
    "locale": "en",
    "template": "string",
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Example · 48 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all communication template (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

, "invoices"

, "ai"

{
  "name": "string",
  "templateType": "automation",
  "communicationChannel": "sms",
  "locale": "en",
  "template": "string",
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

errors

array of FieldError

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Schema ExampleErrorResponse

422 · application/json

{
  "messageCode": "emailTemplateGenerationFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

, "export"

, "accounting"

, "invoices"

, "ai"

Get all communication template#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Create communication template#

Request body

Compile a draft template to preview HTML#

Request body

Write a template from a description#

Request body

Get an communication template#

Parameters

Responses

Responses 200

Update a communication template#

Parameters

Request body

Get communication email templates by channel and type#

Parameters

Responses

Responses 200

Get all communication template#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Create communication template#

Request body

Compile a draft template to preview HTML#

Request body

Write a template from a description#

Request body

Get an communication template#

Parameters

Responses

Responses 200

Update a communication template#

Parameters

Request body

Get communication email templates by channel and type#

Parameters

Responses

Responses 200

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 422

Responses 500

Responses 401

Responses 403

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses 401

Responses 403

Responses 500