Communications | Subrite

Communications

Endpoints for Communications

ReferenceUpdated October 14, 2026View as Markdown

GET/api/v1/communications/sms-short-links/{code}

Looks up the short code, verifies it has not expired, and returns a freshly minted HMAC unsubscribe token, the link expiry timestamp, and the owning tenant hostname. Called by the public short-link resolver page (e.g. subr.no/u/{code}) to redirect into the tenant unsubscribe page.

Authentication: Bearer token (JWT)

Parameters

Path parameters1

codestringRequired
pattern: /^[A-Za-z0-9]{8}$/

Responses

6 status codes

Responses 200

Status200 401 403 404 410 500application/json

Schema ExampleSmsShortLinkResolveResponseDto

4 top-level fieldsSelect an object to expand

tokenstringRequired
Freshly minted HMAC unsubscribe token (base64url) — short-lived, scoped per recipient/consent
expiresAtstring (date-time)Required
When the underlying short link expires (ISO 8601). Token TTL is bounded by this.
tenantHostNamestringRequired
Hostname of the tenant that owns this short link. Lets the short-link domain (e.g. subr.no) redirect to the tenant unsubscribe page.
testContextTestContextDto

Responses 401

Status200 401 403 404 410 500application/json

unauthorized

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring

Responses 403

Status200 401 403 404 410 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Responses 404

Status200 401 403 404 410 500application/json

smsShortLinkNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "smsShortLinkNotFound"
messagestring

Responses 410

Status200 401 403 404 410 500application/json

smsShortLinkExpired

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "smsShortLinkExpired"
messagestring

Responses 500

Status200 401 403 404 410 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/sms-short-links/{code}' \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/communications

Authentication: Bearer token (JWT)

Parameters

Query parameters5

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"

Create a communication set up#

POST/api/v1/communications

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateCommunicationDto

14 top-level fields

communicationTypestringOptional
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
communicationChannelstringRequired

GET/api/v1/communications/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleCommunicationResponseDto

Same fields as Create a communication set up (201).

Send SMS/Email to members of a list by communication ID#

POST/api/v1/communications/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 201

This response has no body.

DELETE/api/v1/communications/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema Exampleobject

No named fields are defined for this schema.

PATCH/api/v1/communications/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateCommunicationDto

15 top-level fields

communicationTypestringOptional
Allowed values: "automation", "crm", "marketing"

GET/api/v1/communications/by-status

Authentication: Bearer token (JWT)

Parameters

Query parameters1

statusstringOptional
Allowed values: "draft", "ready", "scheduled", "completed", "failed", "processing"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

GET/api/v1/communications/email/list

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional

Send a one off email#

POST/api/v1/communications/one-off/email

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleSendOneOffEmailDto

4 top-level fields

emailstring (email)Optional
memberIdstringOptional
subjectstringRequired
message

Email Service API#

POST/api/v1/communications/email/send

Allows authenticated tenants to send emails using the platform email service

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleSendEmailThirdPartyDto

10 top-level fields

namestringRequired
Name of the communication
senderIdnumberRequired
The ID of the senderminimum: 1

SMS Service API#

POST/api/v1/communications/send-single-sms

Allows authenticated tenants to send sms using the platform email service

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateSendSingleSmsDto

5 top-level fields

communicationTypeCOMMUNICATION_TYPERequired
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
phoneNumber

Test a third party email#

POST/api/v1/communications/email/test

Allows authenticated tenants to send test email using the platform email service

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExamplePreviewThirdPartyEmailDto

12 top-level fields

namestringRequired
Name of the communication
senderIdnumberRequired
The ID of the senderminimum: 1

GET/api/v1/communications/email/preview-html/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schedule a third party email#

POST/api/v1/communications/email/schedule

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleScheduleThirdPartyEmailDto

12 top-level fields

namestringRequired
Name of the communication
senderIdnumberRequired
The ID of the senderminimum: 1

Schedule an email by communication id#

POST/api/v1/communications/{id}/email/schedule

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleScheduleEmailDto

11 top-level fields

scheduledAtstring (date-time)Required

GET/api/v1/communications/email/tokens

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleCommunicationPersonalizedTokenDto

2 top-level fields

memberInfo

GET/api/v1/communications/email/templates

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

namestring

GET/api/v1/communications/email/senders

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of CommunicationSender

14 top-level fieldsSelect an object to expand

senderNamestringRequired when parent is present

PATCH/api/v1/communications/email/edit/{id}Deprecated

This endpoint is deprecated as of 2025-10-28. Use PATCH /api/v1/communications/:id/email/edit instead.

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateEmailM2MDto

17 top-level fields

PATCH/api/v1/communications/{id}/email/edit

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateEmailM2MDto

Same fields as DEPRECATED: Update a communication set up for third party (Request body).

Schema ExampleUpdateEmailM2MDto

Schedule a communication#

POST/api/v1/communications/{id}/schedule

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleScheduleCommunicationDto

1 top-level field

scheduledAtstring (date-time)Optional

1 documented field · Scroll to see moreShow full height

Cancel a communication schedule#

POST/api/v1/communications/{id}/schedule/cancel

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Send a test SMS using the given communication ID to verify SMS content#

POST/api/v1/communications/{id}/sms/test

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleTestCommunicateDto

1 top-level field

phoneNumbersarray of string

Send a test email using the given communication ID to verify email content#

POST/api/v1/communications/{id}/email/test

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExamplePreviewEmailDto

10 top-level fields

recipientsarray of string (email)

GET/api/v1/communications/{id}/members/preview

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"

GET/api/v1/communications/{id}/members/audience-split

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

GET/api/v1/communications/{id}/members/communicated

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"

Count the members a communication was sent to and the members it skipped#

GET/api/v1/communications/{id}/members/communicated/summary

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

GET/api/v1/communications/{id}/stats

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleCommunicationStatsResponseDto

Upload template image#

POST/api/v1/communications/template-image/upload

Authentication: Bearer token (JWT)

Request body

Required bodymultipart/form-data

SchemaUploadTemplateImageDto

1 top-level field

imagefileRequired

1 documented field · Scroll to see moreShow full heightShow compact view

Responses

7 status codes

Responses 201

GET/api/v1/communications/{id}/email/statistics

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleEmailStatsResponseDto

Copy a communication setup#

POST/api/v1/communications/{id}/copy

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleCommunicationResponseDto

GET/api/v1/communications/newsletter/communication/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

GET/api/v1/communications/newsletter/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Header parameters1

x-tenant-hoststringRequired
Host the web copy is served on. The email is only found within the tenant that owns it.

Responses

5 status codes

Responses 200

Process one-off email queue with pagination#

POST/api/v1/communications/one-off-email-queue/process

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleProcessOneOffEmailQueueDto

2 top-level fields

pagenumberOptional
Default: 1Page number for paginationminimum: 1
limitnumberOptional

Schema ExampleSmsShortLinkResolveResponseDto

200 · application/json

{
  "token": "<token>",
  "expiresAt": "2019-08-24T14:15:22Z",
  "tenantHostName": "string",
  "testContext": {
    "environment": "string",
    "adminEmail": "string",
    "recipient": "string",
    "sentAt": "2019-08-24T14:15:22Z",
    "messageId": "string"
  }
}

Example · 12 linesShow full heightShow compact view

errors

array of FieldError

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

410 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleCommunicationPaginated

2 top-level fieldsSelect an object to expand

itemsarray of CommunicationRequired36 fields
items
- namestringRequired when parent is presentField path: items[].name
- statusstringRequired when parent is presentField path: items[].status
  Allowed values: "draft", "ready", "scheduled", "completed", "failed", "processing"
- smsContentstringRequired when parent is presentField path: items[].smsContent
- subjectstringRequired when parent is presentField path: items[].subject
- emailEditorRawContentobjectRequired when parent is presentField path: items[].emailEditorRawContent
- communicationTypestringRequired when parent is presentField path: items[].communicationType
  Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
- communicationChannelstringRequired when parent is presentField path: items[].communicationChannel
  Allowed values: "sms", "email"
- scheduledAtstring (date-time)Required when parent is presentField path: items[].scheduledAt
- completedAtstring (date-time)Required when parent is presentField path: items[].completedAt
- adminUserIdnumberRequired when parent is presentField path: items[].adminUserId
- tenantIdnumberRequired when parent is presentField path: items[].tenantId
- consentIdnumberRequired when parent is presentField path: items[].consentId
- segmentIdnumberRequired when parent is presentField path: items[].segmentId
- templateIdnumberRequired when parent is presentField path: items[].templateId
- emailPreviewTextstringRequired when parent is presentField path: items[].emailPreviewText
- deliveryMethodstringRequired when parent is presentField path: items[].deliveryMethod
- externalEmailBodystringRequired when parent is presentField path: items[].externalEmailBody
- emailHtmlPreviewstringRequired when parent is presentField path: items[].emailHtmlPreview
- hostNamestringRequired when parent is presentField path: items[].hostName
  Can be null
- senderIdnumberRequired when parent is presentField path: items[].senderId
- totalRecipientsnumberRequired when parent is presentField path: items[].totalRecipients
  Can be null
- totalPagesnumberRequired when parent is presentField path: items[].totalPages
  Can be null
- audienceBasisstringRequired when parent is presentField path: items[].audienceBasis
  Can be null
- customerWindowMonthsnumberRequired when parent is presentField path: items[].customerWindowMonths
  Can be null
- senderCommunicationSenderRequired when parent is presentField path: items[].sender14 fields
  items[].sender
  - senderNamestringRequired when parent is presentField path: items[].sender.senderName
  - senderEmailstringRequired when parent is presentField path: items[].sender.senderEmail
  - replyTostringRequired when parent is presentField path: items[].sender.replyTo
  - communicationChannelstringRequired when parent is presentField path: items[].sender.communicationChannel
    Allowed values: "sms", "email"
- adminUserUserRequired when parent is presentField path: items[].adminUserNested fields omitted: field limit.
- tenantTenantRequired when parent is presentField path: items[].tenantNested fields omitted: field limit.
- consentConsentRequired when parent is presentField path: items[].consent22 fields
  items[].consent
  - integrationIdstringRequired when parent is presentField path: items[].consent.integrationId
  - titlestringRequired when parent is presentField path: items[].consent.title
  - descriptionstringRequired when parent is presentField path: items[].consent.description
  - imagestringRequired when parent is presentField path: items[].consent.image
  - showOnCheckoutPagebooleanRequired when parent is present
- segmentSegmentRequired when parent is presentField path: items[].segmentNested fields omitted: field limit.
- templateCommunicationTemplateRequired when parent is presentField path: items[].templateNested fields omitted: field limit.
- communicationLogsarray of CommunicationLogRequired when parent is presentField path: items[].communicationLogsNested fields omitted: field limit.
- idnumberRequired when parent is presentField path: items[].id
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
- updatedAtstring (date-time)Required when parent is presentField path: items[].updatedAt
- deletedAtstring (date-time)Required when parent is presentField path: items[].deletedAt
- metaDataobjectRequired when parent is presentField path: items[].metaData
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExampleCommunicationPaginated

200 · application/json

{
  "items": [
    {
      "emailEditorRawContent": {},
      "communicationLogs": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 lines

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleCreateCommunicationDto

application/json

{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}

Example · 16 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema ExampleCommunicationResponseDto

27 top-level fieldsSelect an object to expand

idnumberRequired
namestringRequired
communicationTypestringRequired
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
smsContentstringRequired
Can be null
subjectstringRequired
Can be null
emailEditorRawContentobjectRequired
Can be null
emailPreviewTextstringRequired
Can be null
statusstringRequired
Allowed values: "draft", "ready", "scheduled", "completed", "failed", "processing"
communicationChannelstringRequired
Allowed values: "sms", "email"
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
senderIdnumberRequired
senderstringRequired
segmentIdnumberRequired
segmentNamestringRequired
consentIdnumberRequired
consentNamestringRequired
tenantIdnumberRequired
adminUserIdnumberRequired
adminUserNamestringRequired
emailHtmlPreviewstringRequired
Can be null
templateCommunicationTemplateRequiredCan be null12 fields
template
- namestringRequired when parent is presentField path: template.name
- templateTypestringRequired when parent is presentField path: template.templateType
  Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
- communicationChannelstringRequired when parent is presentField path: template.communicationChannel
  Allowed values: "sms", "email"
- localestringRequired when parent is present
scheduledAtstring (date-time)Required
Can be null
completedAtstring (date-time)Required
Can be null
deliveryMethodstringRequired
externalEmailBodystringRequired
Can be null
senderEmailstringRequired
Can be null

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

Schema ExampleCommunicationResponseDto

201 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full height

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}'

Schema ExampleCommunicationResponseDto

200 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "communicationNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

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

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "communicationIsNotReady", "senderEmailUnapproved"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

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

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

, "otp"

, "information"

, "emailStandard"

, "jobCompletion"

, "oneOff"

Schema ExampleUpdateCommunicationDto

application/json

{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "emailContent": "<p>Hello {{name}},</p><p>Your email content here...</p>",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}

Example · 17 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleCommunicationResponseDto

Same fields as Create a communication set up (201).

Schema ExampleCommunicationResponseDto

200 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest, communicationCannotBeUpdated, scheduledTimeMustBeInTheFuture

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "communicationCannotBeUpdated", "scheduledTimeMustBeInTheFuture"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "emailContent": "<p>Hello {{name}},</p><p>Your email content here...</p>",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}'

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleCommunicationPaginated

Same fields as Get all communication set ups (200).

Schema ExampleCommunicationPaginated

200 · application/json

{
  "items": [
    {
      "emailEditorRawContent": {},
      "communicationLogs": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 17 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 lines

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

string

Schema ExampleSendOneOffEmailDto

application/json

{
  "email": "user@example.com",
  "memberId": "string",
  "subject": "string",
  "message": {
    "summary": "Plain text message",
    "value": "Hello, this is a plain text message with line breaks.\n\nThis is a new paragraph."
  }
}

Example · 9 linesShow full heightShow compact view

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications/one-off/email \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "memberId": "string",
  "subject": "string",
  "message": {
    "summary": "Plain text message",
    "value": "Hello, this is a plain text message with line breaks.\n\nThis is a new paragraph."
  }
}'

Schema ExampleSendEmailThirdPartyDto

application/json

{
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "subject": "string",
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string",
  "hostName": "string"
}

Example · 12 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleThirdPartyEmailResponseDto

3 top-level fields

successbooleanRequired
messagestringRequired
idnumberRequired

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

Schema ExampleThirdPartyEmailResponseDto

201 · application/json

{
  "success": true,
  "message": "Email sent successfully",
  "id": 123
}

Example · 5 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

communicationIsNotReady, senderEmailUnapproved

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "communicationIsNotReady", "senderEmailUnapproved"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications/email/send \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "subject": "string",
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string",
  "hostName": "string"
}'

string

Schema ExampleCreateSendSingleSmsDto

application/json

{
  "communicationType": "automation",
  "phoneNumber": "<phoneNumber>",
  "message": "string",
  "senderId": 0,
  "memberId": "string"
}

Example · 7 linesShow full heightShow compact view

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications/send-single-sms \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationType": "automation",
  "phoneNumber": "<phoneNumber>",
  "message": "string",
  "senderId": 0,
  "memberId": "string"
}'

Schema ExamplePreviewThirdPartyEmailDto

application/json

{
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string",
  "hostName": "string",
  "subject": "string",
  "recipients": [
    "recipient1@example.com",
    "recipient2@example.com"
  ],
  "id": 1
}

Example · 17 linesShow full heightShow compact view

Responses

9 status codes

Responses 201

Status201 400 401 403 404 422 500 502 503application/json

Schema ExampleEmailTestResponseDto

3 top-level fields

successbooleanRequired
messagestringRequired
idnumberRequired

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

Schema ExampleEmailTestResponseDto

201 · application/json

{
  "success": true,
  "message": "Email sent successfully",
  "id": 123
}

Example · 5 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 422 500 502 503application/json

communicationChannelNotSupported

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "communicationChannelNotSupported"

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 422 500 502 503application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

Responses 404

Status201 400 401 403 404 422 500 502 503application/json

notFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notFound"

Responses 422

Status201 400 401 403 404 422 500 502 503application/json

emailProviderRequestInvalid

Schema ExampleErrorResponse

Same fields as Send a one off email (422).

Schema ExampleErrorResponse

Responses 500

Status201 400 401 403 404 422 500 502 503application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Responses 502

Status201 400 401 403 404 422 500 502 503application/json

emailProviderUnavailable

Schema ExampleErrorResponse

Same fields as Send a one off email (502).

Schema ExampleErrorResponse

Responses 503

Status201 400 401 403 404 422 500 502 503application/json

emailProviderRateLimited

Schema ExampleErrorResponse

Same fields as Send a one off email (503).

Schema ExampleErrorResponse

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications/email/test \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string",
  "hostName": "string",
  "subject": "string",
  "recipients": [
    "recipient1@example.com",
    "recipient2@example.com"
  ],
  "id": 1
}'

EmailPreviewHtmlDto

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleScheduleThirdPartyEmailDto

application/json

{
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string",
  "hostName": "string",
  "subject": "string",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo"
}

Example · 14 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleThirdPartyEmailResponseDto

Same fields as Email Service API (201).

Schema ExampleThirdPartyEmailResponseDto

201 · application/json

{
  "success": true,
  "message": "Email sent successfully",
  "id": 123
}

Example · 5 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

scheduledTimeMustBeInTheFuture

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "scheduledTimeMustBeInTheFuture"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications/email/schedule \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string",
  "hostName": "string",
  "subject": "string",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo"
}'

Schema ExampleScheduleEmailDto

application/json

{
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo",
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "subject": "string",
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string"
}

Example · 13 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleEmailScheduleResponseDto

4 top-level fieldsSelect an object to expand

successbooleanRequired
messagestringRequired
idnumberRequired
communicationCommunicationResponseDtoRequired27 fields
communication
- idnumberRequiredField path: communication.id
- namestringRequiredField path: communication.name
- communicationTypestringRequiredField path: communication.communicationType
  Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
- smsContentstringRequiredField path: communication.smsContent
  Can be null

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

Schema ExampleEmailScheduleResponseDto

201 · application/json

{
  "success": true,
  "message": "Email sent successfully",
  "id": 123,
  "communication": "Communication"
}

Example · 6 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, scheduledTimeMustBeInTheFuture, scheduledFailed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "scheduledTimeMustBeInTheFuture", "scheduledFailed"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/{id}/email/schedule' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo",
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "subject": "string",
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string"
}'

array of string

Schema ExampleCommunicationPersonalizedTokenDto

200 · application/json

{
  "memberInfo": [
    "string"
  ],
  "myPageLink": [
    "string"
  ]
}

Example · 8 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

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 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 Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

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.smsSenderRecursive schema; nested fields are not repeated.
emailSenderCommunicationSenderRequired when parent is presentField path: [].tenant.emailSenderRecursive schema; nested fields are not repeated.
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.communicationTemplatesNested fields omitted: field limit.
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 Examplearray of CommunicationSender

200 · application/json

[
  {
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "communicationChannel": "sms",
    "providerRegion": "global",
    "status": "pending",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "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 · 50 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleUpdateEmailM2MDto

application/json

{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "emailContent": "<p>Hello {{name}},</p><p>Your email content here...</p>",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}

Example · 19 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleCommunicationResponseDto

Same fields as Create a communication set up (201).

Schema ExampleCommunicationResponseDto

200 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest, communicationCannotBeUpdated, scheduledTimeMustBeInTheFuture

Schema ExampleErrorResponse

Same fields as Update a communication set up (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/email/edit/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "emailContent": "<p>Hello {{name}},</p><p>Your email content here...</p>",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}'

application/json

{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "emailContent": "<p>Hello {{name}},</p><p>Your email content here...</p>",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleCommunicationResponseDto

Same fields as Create a communication set up (201).

Schema ExampleCommunicationResponseDto

200 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest, communicationCannotBeUpdated, scheduledTimeMustBeInTheFuture

Schema ExampleErrorResponse

Same fields as Update a communication set up (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/{id}/email/edit' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationType": "automation",
  "communicationChannel": "sms",
  "emailContent": "<p>Hello {{name}},</p><p>Your email content here...</p>",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "timeZone": "Europe/Oslo",
  "name": "string",
  "senderId": 0,
  "consentId": 0,
  "segmentId": 0,
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "templateId": 0,
  "emailPreviewText": "string",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "hostName": "string"
}'

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleCommunicationResponseDto

Same fields as Create a communication set up (201).

Schema ExampleCommunicationResponseDto

201 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, scheduledTimeMustBeInTheFuture, scheduledFailed, senderEmailUnapproved

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "scheduledTimeMustBeInTheFuture", "scheduledFailed", "senderEmailUnapproved"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/{id}/schedule' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scheduledAt": "2019-08-24T14:15:22Z"
}'

CommunicationResponseDto

Schema ExampleCommunicationResponseDto

201 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, communicationIsNotScheduled

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "communicationIsNotScheduled"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- message

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

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/{id}/sms/test' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumbers": [
    "<phoneNumbers>"
  ]
}'

Schema ExamplePreviewEmailDto

application/json

{
  "recipients": [
    "recipient1@example.com",
    "recipient2@example.com"
  ],
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "subject": "string",
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string"
}

Example · 15 linesShow full heightShow compact view

Responses

9 status codes

Responses 201

Status201 400 401 403 404 422 500 502 503application/json

Schema ExampleEmailTestResponseDto

Same fields as Test a third party email (201).

Schema ExampleEmailTestResponseDto

201 · application/json

{
  "success": true,
  "message": "Email sent successfully",
  "id": 123
}

Example · 5 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 422 500 502 503application/json

badRequest, wrongCommunicationChannel, senderEmailUnapproved

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values:

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 422 500 502 503application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

Responses 404

Status201 400 401 403 404 422 500 502 503application/json

notFound

Schema ExampleErrorResponse

Same fields as Test a third party email (404).

Schema ExampleErrorResponse

Responses 422

Status201 400 401 403 404 422 500 502 503application/json

emailProviderRequestInvalid

Schema ExampleErrorResponse

Same fields as Send a one off email (422).

Schema ExampleErrorResponse

Responses 500

Status201 400 401 403 404 422 500 502 503application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Responses 502

Status201 400 401 403 404 422 500 502 503application/json

emailProviderUnavailable

Schema ExampleErrorResponse

Same fields as Send a one off email (502).

Schema ExampleErrorResponse

Responses 503

Status201 400 401 403 404 422 500 502 503application/json

emailProviderRateLimited

Schema ExampleErrorResponse

Same fields as Send a one off email (503).

Schema ExampleErrorResponse

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/communications/{id}/email/test' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "recipients": [
    "recipient1@example.com",
    "recipient2@example.com"
  ],
  "name": "string",
  "senderId": 1,
  "communicationType": "marketing",
  "consentId": 1,
  "segmentId": 1,
  "subject": "string",
  "emailPreviewText": "string",
  "templateId": 1,
  "emailContent": "string"
}'

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleCommunicationMembersResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of CommunicationMembersResponseDtoRequired7 fields
items
- idstringRequired when parent is presentField path: items[].id
- fullNamestringRequired when parent is presentField path: items[].fullName
- emailstringRequired when parent is presentField path: items[].email
- phonestringRequired when parent is presentField path: items[].phone
- statusstringField path: items[].status
- memberNumbernumberRequired when parent is presentField path: items[].memberNumber
- userIdnumberRequired when parent is presentField path: items[].userId
  Can be null
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExampleCommunicationMembersResponseDtoPaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleCommunicationAudienceSplitResponseDto

9 top-level fieldsSelect an object to expand

modestringRequired
Which rule the split follows: 'none' (no consent object, channel address only), 'consent' (accepted consent required), or 'legitimate_interests' (existing customers plus consent)Allowed values: "none", "consent", "legitimate_interests"
customerWindowMonthsnumberRequired
Can be nullThe customer relationship window applied under legitimate interests
segmentTotalnumberRequired
Members of the list with a usable address for the channel
existingCustomersnumberRequired
Reachable as existing customers under legitimate interests
viaConsentnumberRequired
Reachable through accepted consent on the selected consent object
totalnumberRequired
Recipients of the send: existingCustomers + viaConsent
excludednumberRequired
Members of the list the send will not reach
legalReferencesCommunicationAudienceLegalReferencesDtoRequired3 fields
legalReferences
- existingCustomersstringRequiredField path: legalReferences.existingCustomers
- viaConsentstringRequiredField path: legalReferences.viaConsent
- excludedstringRequiredField path: legalReferences.excluded
marketingLawShortstringRequired

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

Schema ExampleCommunicationAudienceSplitResponseDto

200 · application/json

{
  "mode": "none",
  "customerWindowMonths": 0,
  "segmentTotal": 0,
  "existingCustomers": 0,
  "viaConsent": 0,
  "total": 0,
  "excluded": 0,
  "legalReferences": {
    "existingCustomers": "GDPR art. 6(1)(f) · markedsføringsloven § 15(3)",
    "viaConsent": "GDPR art. 6(1)(a) · markedsføringsloven § 15(1)",
    "excluded": "markedsføringsloven § 15(1) · no consent on record"
  },
  "marketingLawShort": "mfl. § 15"
}

Example · 15 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleCommunicationMembersResponseDtoPaginated

Same fields as Preview communication members (200).

Schema ExampleCommunicationMembersResponseDtoPaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleTemplateImageUploadResponseDto

1 top-level field

imageUrlstringRequired

1 documented field · Scroll to see moreShow full heightShow compact view

Schema ExampleTemplateImageUploadResponseDto

201 · application/json

{
  "imageUrl": "string"
}

Example · 3 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 413 415 500application/json

badRequest with errors[] = templateImageRequired on image

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 413 415 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleEmailStatsResponseDto

200 · application/json

{
  "totalProcessed": 0,
  "totalDelivered": 0,
  "totalNotDelivered": 0,
  "totalHardBounced": 0,
  "totalOpened": 0,
  "totalUniqueOpened": 0,
  "totalClicked": 0,
  "totalUniqueClicked": 0,
  "totalDeliveredPercentage": 0,
  "totalNotDeliveredPercentage": 0,
  "totalOpenedPercentage": 0,
  "totalClickedPercentage": 0,
  "totalNotOpened": 0,
  "urlStats": [
    {}
  ]
}

Example · 18 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleCommunicationResponseDto

201 · application/json

{
  "id": 0,
  "name": "string",
  "communicationType": "automation",
  "smsContent": "string",
  "subject": "string",
  "emailEditorRawContent": {},
  "emailPreviewText": "string",
  "status": "draft",
  "communicationChannel": "sms",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "senderId": 0,
  "sender": "string",
  "segmentId": 0,
  "segmentName": "string",
  "consentId": 0,
  "consentName": "string",
  "tenantId": 0,
  "adminUserId": 0,
  "adminUserName": "<adminUserName>",
  "emailHtmlPreview": "string",
  "template": {
    "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": {}
  },
  "scheduledAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "externalEmailBody": "string",
  "senderEmail": "string"
}

Example · 74 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all communication set ups (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status201 400 401 403 404 500application/json

communicationNotFound

Schema ExampleErrorResponse

Same fields as Get a communication set up (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

NewsletterMessageIdResponseDto

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Responses 404

Status200 400 401 403 404 500application/json

newsletterNotFound

application/json

Responses 401

Status200 401 403 404 500application/json

unauthorized

Responses 404

Status200 401 403 404 500application/json

newsletterNotFound

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema Exampleobject

No named fields are defined for this schema.

Schema Exampleobject

201 · application/json

{}

Example · 1 lineShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Schema ExampleErrorResponse

403 · application/json

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Resolve an SMS unsubscribe short code (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/communications/one-off-email-queue/process \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "page": 1,
  "limit": 10
}'

fieldValue

string

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

Schema ExampleErrorResponse

422 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

502 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

503 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

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

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

Schema ExampleErrorResponse

422 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

502 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

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

message

string

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

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

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

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

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

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

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

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

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

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

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

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

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

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

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

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

string

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

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

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

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

"badRequest"

, "wrongCommunicationChannel"

, "senderEmailUnapproved"

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

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

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

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

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

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

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

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

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

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

string

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

Resolve an SMS unsubscribe short code#

Parameters

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 410

Responses 500

Get all communication set ups#

Parameters

Create a communication set up#

Request body

Get a communication set up#

Parameters

Responses

Responses 200

Send SMS/Email to members of a list by communication ID#

Parameters

Responses

Responses 201

Delete a communication set up#

Parameters

Responses

Responses 200

Update a communication set up#

Parameters

Request body

Get communications, optionally filtered by status (for segment filtering)#

Parameters

Responses

Responses 200

Get all emails of users tenant#

Parameters

Send a one off email#

Request body

Email Service API#

Request body

SMS Service API#

Request body

Test a third party email#

Request body

Preview an email#

Parameters

Responses

Responses 200

Schedule a third party email#

Request body

Schedule an email by communication id#

Parameters

Request body

Get personalized tokens for email communication#

Responses

Responses 200

Get communication email templates#

Responses

Responses 200

Get all email sender#

Responses

Responses 200

DEPRECATED: Update a communication set up for third party#

Parameters

Request body

Update a communication set up for email third party#

Parameters

Request body

Schedule a communication#

Parameters

Request body

Cancel a communication schedule#

Parameters

Responses

Responses 201

Send a test SMS using the given communication ID to verify SMS content#

Parameters

Request body

Send a test email using the given communication ID to verify email content#

Parameters

Request body

Preview communication members#