Tenant | Subrite

Tenant

Endpoints for Tenant

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/tenants/settings

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleTenantResponse

36 top-level fieldsSelect an object to expand

marketstring
Market name for the tenantAllowed values: "NO", "SE", "DK"
productNamestring
Product name for the tenantAllowed values: "enterprise", "communication", "custom"
additionalFeaturesarray of string
Field details
Additional features enabled for the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting", "invoices", "ai"
disabledFeaturesarray of string

Schema ExampleTenantResponse

200 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Responses 404

Status200 401 403 404 500application/json

tenantNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "tenantNotFound"
messagestring
errorsarray of FieldErrorRequired

Responses 500

Status200 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

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

Try it

PATCH/api/v1/tenants/settings

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUpdateTenantSettingsDto

28 top-level fieldsSelect an object to expand

isActivebooleanOptional
addressTenantAddressDtoOptional12 fields
address
- companyNamestring

Upload a tenant settings image#

POST/api/v1/tenants/settings/images

Authentication: Bearer token (JWT)

Request body

Required bodymultipart/form-data

SchemaUploadTenantImageDto

4 top-level fields

propertyNameTenantImagePropertyRequired
Allowed values: "logo", "favicon", "welcomeImage", "paymentConfirmationImage", "invoiceLogo", "subscriptionChangeCompleteScreenImage", "authLogo"
imagefileOptional

Upload a tenant settings font#

POST/api/v1/tenants/settings/fonts

Authentication: Bearer token (JWT)

Request body

Required bodymultipart/form-data

SchemaUploadFontDto

5 top-level fieldsSelect an object to expand

fontTypeFontTypeRequired
Allowed values: "PrimaryFont", "SecondaryFont"
fontConfigFontConfigRequired5 conditional requirements in nested objects2 fields
fontConfig

GET/api/v1/tenants

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
Default: "desc"Allowed values:

GET/api/v1/tenants/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleTenantResponse

Same fields as Get tenants settings (200).

PATCH/api/v1/tenants/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateTenantDto

35 top-level fieldsSelect an object to expand

isActivebooleanOptional
isOnboardingbooleanOptional

PATCH/api/v1/tenants/{id}/preference

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleTenantPreferenceUpdateDto

41 top-level fieldsSelect an object to expand

welcomeImagestringOptional
Can be null

GET/api/v1/tenants/hostname/{hostname}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

hostnamestringRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

GET/api/v1/tenants/additional-hostname/available

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of TenantAdditionalHostnameDto

7 top-level fieldsSelect an object to expand

GET/api/v1/tenants/additional-hostname/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Add additional hostname to a tenant#

POST/api/v1/tenants/additional-hostname/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleNewTenantAdditionalHostnameDto

2 top-level fields

hostNamestringRequired

DELETE/api/v1/tenants/additional-hostname/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleRemoveTenantAdditionalHostnameDto

1 top-level field

hostNamestringRequired

1 documented field · Scroll to see more

PATCH/api/v1/tenants/additional-hostname/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateTenantAdditionalHostnameDto

3 top-level fields

newHostNamestringRequired

preferencePreferenceResponseDtoRequired41 fields

preference

welcomeImagestringField path: preference.welcomeImage
Can be null
headerTextstringField path: preference.headerText
Can be null
headerLogoHeightnumberField path: preference.headerLogoHeight
Can be nullminimum: 1maximum: 500
welcomePrimaryTextstringField path: preference.welcomePrimaryText
Can be null
welcomeSecondaryTextstringField path: preference.welcomeSecondaryText
Can be null
memberInfoTextstringField path: preference.memberInfoText
Can be null
paymentConfirmationImagestringField path: preference.paymentConfirmationImage
Can be null
subscriptionChangeCompleteScreenImagestringField path: preference.subscriptionChangeCompleteScreenImage
Can be null
paymentConfirmationPrimaryTextstringField path: preference.paymentConfirmationPrimaryText
Can be null
paymentConfirmationSecondaryTextLoggedOutstringField path: preference.paymentConfirmationSecondaryTextLoggedOut
Can be null
paymentConfirmationSecondaryTextLoggedInstringField path: preference.paymentConfirmationSecondaryTextLoggedIn
Can be null
headerColorstringField path: preference.headerColor
Can be null
headerTextColorstringField path: preference.headerTextColor
Can be null
primaryButtonColorstringField path: preference.primaryButtonColor
Can be null
primaryButtonHoverColorstringField path: preference.primaryButtonHoverColor
Can be null
primaryButtonTextColorstringField path: preference.primaryButtonTextColor
Can be null
primaryStepColorstringField path: preference.primaryStepColor
Can be null
onboardingFlowbooleanField path: preference.onboardingFlow
invoiceLogostringField path: preference.invoiceLogo
Can be null
allowedDaysAfterExpirynumberField path: preference.allowedDaysAfterExpiry
minimum: 0
onNewUserCompletedPackageIdnumberField path: preference.onNewUserCompletedPackageId
Can be null
allowBuyNewSubsFromMypagebooleanField path: preference.allowBuyNewSubsFromMypage
allowBuyGiftSubsFromMypagebooleanField path: preference.allowBuyGiftSubsFromMypage
onNewUserCompletedNewsletterAndConsentbooleanField path: preference.onNewUserCompletedNewsletterAndConsent
showBuyNewSubscriptionCTAbooleanField path: preference.showBuyNewSubscriptionCTA
buyNewSubscriptionPackageIdnumberField path: preference.buyNewSubscriptionPackageId
Can be null
showPodcastSearchbooleanField path: preference.showPodcastSearch
eInvoicePaymentPreferenceEInvoicePaymentPreferenceRequiredField path: preference.eInvoicePaymentPreferenceNested fields omitted: field limit.
checkoutWelcomeCTAConfigCheckoutWelcomeCTAConfigRequiredField path: preference.checkoutWelcomeCTAConfigNested fields omitted: field limit.
giftSubscriptionConfirmationTextLoggedInstringField path: preference.giftSubscriptionConfirmationTextLoggedIn
Can be null
giftSubscriptionWelcomeHelpTextstringField path: preference.giftSubscriptionWelcomeHelpText
Can be null
systemUpgradeNotificationTranslationRequiredField path: preference.systemUpgradeNotification
Can be null
Nested fields omitted: field limit.
orderCtaLabelTranslationField path: preference.orderCtaLabel
Can be null
Nested fields omitted: field limit.
inputFieldConfigarray of PageInputFieldConfigRequiredField path: preference.inputFieldConfigNested fields omitted: field limit.
maintenanceModeConfigMaintenanceModeConfigRequiredField path: preference.maintenanceModeConfig
Can be null
Nested fields omitted: field limit.
permissionLevelForBuyingMultipleSubscriptionsPermissionLevelForBuyingMultipleSubscriptionsRequiredField path: preference.permissionLevelForBuyingMultipleSubscriptions
Allowed values: "allow", "warn", "block"
themeThemeConfigField path: preference.theme
Can be null
Nested fields omitted: field limit.
customFieldsOnMemberCardarray of stringField path: preference.customFieldsOnMemberCard
visibleAdditionalFieldsOnMypagearray of stringRequiredField path: preference.visibleAdditionalFieldsOnMypage
customFieldsOnInvoicearray of CustomFieldsOnInvoiceDtoRequiredField path: preference.customFieldsOnInvoice
Can be null
Nested fields omitted: field limit.
myPagePackageSortMyPagePackageSortConfigRequiredField path: preference.myPagePackageSortNested fields omitted: field limit.

{
  "market": "NO",
  "productName": "enterprise",
  "additionalFeatures": [
    "email"
  ],
  "disabledFeatures": [
    "email"
  ],
  "id": 0,
  "name": "string",
  "isActive": true,
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "tenantContact": "string",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "oauthProviders": [
    {}
  ],
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "entityId": "string",
    "entity": "string",
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "addressType": "primary",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "route": "string",
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "emailSenderId": 0,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsOtp": true,
  "smsSenderId": 0,
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  }
}

Schema ExampleUpdateTenantSettingsDto

application/json

{
  "isActive": true,
  "address": {
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "addressType": "primary"
  },
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "inputFieldConfig": [],
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": []
  },
  "name": "string",
  "defaultLanguage": "en",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "tenantContact": "string",
  "emailSenderId": 0,
  "smsSenderId": 0,
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  }
}

Example · 86 linesShow full heightShow compact view

Responses

7 status codes

Responses 200

Status200 400 401 403 404 409 500application/json

Schema ExampleTenantResponse

Same fields as Get tenants settings (200).

Schema ExampleTenantResponse

200 · application/json

{
  "market": "NO",
  "productName": "enterprise",
  "additionalFeatures": [
    "email"
  ],
  "disabledFeatures": [
    "email"
  ],
  "id": 0,
  "name": "string",
  "isActive": true,
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "tenantContact": "string",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "oauthProviders": [
    {}
  ],
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "entityId": "string",
    "entity": "string",
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "addressType": "primary",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "route": "string",
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "emailSenderId": 0,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsOtp": true,
  "smsSenderId": 0,
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  }
}

Example · 129 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 409 500application/json

Body validation failed, the product and feature-entitlement combination is not valid, or the login-method settings contradict each other; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError", "tenantSettingsInvalidFeatures", "otpChannelRequired", "primaryOtpChannelDisabled", "smsSenderRequired"

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 404

Status200 400 401 403 404 409 500application/json

tenantNotFound, tenantPreferenceNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "tenantNotFound", "tenantPreferenceNotFound"
messagestring

Responses 409

Status200 400 401 403 404 409 500application/json

The selected default sender is not approved for this tenant

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "emailSenderNotApproved", "smsSenderNotApproved"
messagestring

Responses 500

Status200 400 401 403 404 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/tenants/settings \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isActive": true,
  "address": {
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "addressType": "primary"
  },
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "name": "string",
  "defaultLanguage": "en",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "tenantContact": "string",
  "emailSenderId": 0,
  "smsSenderId": 0,
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  }
}'

Try it

Send a real request to api.subrite.no from your browser. Your token is only kept in this tab, until you reload or close it.

PATCH https://api.subrite.no/api/v1/tenants/settings

Bearer token · Required

Request body (JSON)

{
  "isActive": true,
  "address": {
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "addressType": "primary"
  },
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "name": "string",
  "defaultLanguage": "en",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "tenantContact": "string",
  "emailSenderId": 0,
  "smsSenderId": 0,
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  }
}

imageUrl

string (uri)

Responses

9 status codes

Responses 201

Status201 400 401 403 404 413 415 500 502application/json

Schema Exampleboolean

No named fields are defined for this schema.

Schema Exampleboolean

201 · application/json

true

Example · 1 lineShow full heightShow compact view

Responses 400

Status201 400 401 403 404 413 415 500 502application/json

Body validation failed, the file type is not accepted, or neither an image nor the remove-previous-image flag was provided

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError",

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 413 415 500 502application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

Responses 404

Status201 400 401 403 404 413 415 500 502application/json

tenantNotFound, tenantPreferenceNotFound

Schema ExampleErrorResponse

Same fields as Update a tenant settings (404).

Schema ExampleErrorResponse

Responses 413

fileSizeExceeded

This response has no body.

Responses 415

invalidFileType

This response has no body.

Responses 500

Status201 400 401 403 404 413 415 500 502application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Responses 502

Status201 400 401 403 404 413 415 500 502application/json

The image could not be stored; nothing was saved

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "tenantAssetUploadFailed"

Example requestcurl

curl

curl https://api.subrite.no/api/v1/tenants/settings/images \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --form 'propertyName=logo' \
  --form 'image=@<file>'

Responses

9 status codes

Responses 201

Status201 400 401 403 404 413 415 500 502application/json

Schema Exampleboolean

No named fields are defined for this schema.

Schema Exampleboolean

201 · application/json

true

Example · 1 lineShow full heightShow compact view

Responses 400

Status201 400 401 403 404 413 415 500 502application/json

Body validation failed, no font file was provided, or the font configuration carries no font source. A malformed fontConfig arrives as invalidFormat against that field in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError"

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 413 415 500 502application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

Responses 404

Status201 400 401 403 404 413 415 500 502application/json

tenantNotFound, tenantPreferenceNotFound

Schema ExampleErrorResponse

Same fields as Update a tenant settings (404).

Schema ExampleErrorResponse

Responses 413

fileSizeExceeded

This response has no body.

Responses 415

invalidFileType

This response has no body.

Responses 500

Status201 400 401 403 404 413 415 500 502application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Responses 502

Status201 400 401 403 404 413 415 500 502application/json

The font could not be stored; nothing was saved

Schema ExampleErrorResponse

Same fields as Upload a tenant settings image (502).

Schema ExampleErrorResponse

Example requestcurl

curl

curl https://api.subrite.no/api/v1/tenants/settings/fonts \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --form 'fontType=PrimaryFont' \
  --form 'font=@<file>'

"asc"

, "desc"

Responses

5 status codes

Responses 200

This response has no body.

Responses 400

Status200 400 401 403 500application/json

Query validation failed; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError"
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

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 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get tenants settings (403).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

200 · application/json

{
  "market": "NO",
  "productName": "enterprise",
  "additionalFeatures": [
    "email"
  ],
  "disabledFeatures": [
    "email"
  ],
  "id": 0,
  "name": "string",
  "isActive": true,
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "tenantContact": "string",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "oauthProviders": [
    {}
  ],
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "entityId": "string",
    "entity": "string",
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "addressType": "primary",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "route": "string",
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "emailSenderId": 0,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsOtp": true,
  "smsSenderId": 0,
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  }
}

Example · 129 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The id is not an integer

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
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

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

tenantNotFound

Schema ExampleErrorResponse

Same fields as Get tenants settings (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleUpdateTenantDto

application/json

{
  "isActive": true,
  "isOnboarding": true,
  "address": {
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "addressType": "primary"
  },
  "productName": "enterprise",
  "additionalFeatures": [
    "insights",
    "podcasts"
  ],
  "disabledFeatures": [
    "sms"
  ],
  "name": "string",
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "tenantContact": "string",
  "emailSenderId": 0,
  "smsSenderId": 0,
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  }
}

Example · 63 linesShow full heightShow compact view

Responses

7 status codes

Responses 200

Status200 400 401 403 404 409 500application/json

Schema ExampleTenantResponse

Same fields as Get tenants settings (200).

Schema ExampleTenantResponse

200 · application/json

{
  "market": "NO",
  "productName": "enterprise",
  "additionalFeatures": [
    "email"
  ],
  "disabledFeatures": [
    "email"
  ],
  "id": 0,
  "name": "string",
  "isActive": true,
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "tenantContact": "string",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "oauthProviders": [
    {}
  ],
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "entityId": "string",
    "entity": "string",
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "addressType": "primary",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "route": "string",
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "emailSenderId": 0,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsOtp": true,
  "smsSenderId": 0,
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  }
}

Example · 129 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 409 500application/json

Body validation failed, the id is not an integer, the product and feature-entitlement combination is not valid, or the login-method settings contradict each other; field codes in errors[]

Schema ExampleErrorResponse

Same fields as Update a tenant settings (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

Status200 400 401 403 404 409 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status200 400 401 403 404 409 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get tenants settings (403).

Responses 404

Status200 400 401 403 404 409 500application/json

tenantNotFound

Schema ExampleErrorResponse

Same fields as Get tenants settings (404).

Schema ExampleErrorResponse

404 · application/json

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

Responses 409

Status200 400 401 403 404 409 500application/json

The selected default sender is not approved for this tenant

Schema ExampleErrorResponse

Same fields as Update a tenant settings (409).

Schema ExampleErrorResponse

409 · application/json

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

Responses 500

Status200 400 401 403 404 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/tenants/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isActive": true,
  "isOnboarding": true,
  "address": {
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "addressType": "primary"
  },
  "productName": "enterprise",
  "additionalFeatures": [
    "insights",
    "podcasts"
  ],
  "disabledFeatures": [
    "sms"
  ],
  "name": "string",
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "tenantContact": "string",
  "emailSenderId": 0,
  "smsSenderId": 0,
  "emailProvider": "brevo",
  "emailProviderAPIKey": "<emailProviderAPIKey>",
  "emailProviderSignatureVerificationKey": "<emailProviderSignatureVerificationKey>",
  "registeredBusinessNo": "string",
  "bankAccountNo": "string",
  "swiftCode": "string",
  "iban": "<iban>",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  }
}'

Schema ExampleTenantPreferenceUpdateDto

application/json

{
  "welcomeImage": "string",
  "headerText": "string",
  "headerLogoHeight": 1,
  "welcomePrimaryText": "string",
  "welcomeSecondaryText": "string",
  "memberInfoText": "string",
  "paymentConfirmationImage": "string",
  "subscriptionChangeCompleteScreenImage": "string",
  "paymentConfirmationPrimaryText": "string",
  "paymentConfirmationSecondaryTextLoggedOut": "string",
  "paymentConfirmationSecondaryTextLoggedIn": "string",
  "headerColor": "string",
  "headerTextColor": "string",
  "primaryButtonColor": "string",
  "primaryButtonHoverColor": "string",
  "primaryButtonTextColor": "string",
  "primaryStepColor": "string",
  "onboardingFlow": true,
  "invoiceLogo": "string",
  "allowedDaysAfterExpiry": 0,
  "onNewUserCompletedPackageId": 0,
  "allowBuyNewSubsFromMypage": true,
  "allowBuyGiftSubsFromMypage": true,
  "onNewUserCompletedNewsletterAndConsent": true,
  "showBuyNewSubscriptionCTA": true,
  "buyNewSubscriptionPackageId": 0,
  "showPodcastSearch": true,
  "eInvoicePaymentPreference": {
    "initialActivation": "ON_PAYMENT",
    "dueDaysAfterOrderForInitial": 0,
    "initialDeactivation": "ON_DUE",
    "initialOnDueDeactivationBufferDays": 0,
    "orderDaysBeforeRenewal": 0,
    "dueDaysAfterOrderForRecurring": 0,
    "recurringDeactivation": "ON_DUE",
    "recurringOnDueDeactivationBufferDays": 0
  },
  "giftSubscriptionConfirmationTextLoggedIn": "string",
  "giftSubscriptionWelcomeHelpText": "string",
  "systemUpgradeNotification": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "permissionLevelForBuyingMultipleSubscriptions": "allow",
  "customFieldsOnMemberCard": [
    "string"
  ],
  "visibleAdditionalFieldsOnMypage": [
    "string"
  ],
  "myPagePackageSort": {
    "mode": "name",
    "direction": "asc"
  }
}

Example · 66 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExamplePreferenceResponseDto

41 top-level fieldsSelect an object to expand

welcomeImagestring
Can be null
headerTextstring
Can be null
headerLogoHeightnumber
Can be nullminimum: 1maximum: 500
welcomePrimaryTextstring
Can be null
welcomeSecondaryTextstring
Can be null
memberInfoTextstring
Can be null
paymentConfirmationImagestring
Can be null
subscriptionChangeCompleteScreenImagestring
Can be null
paymentConfirmationPrimaryTextstring
Can be null
paymentConfirmationSecondaryTextLoggedOutstring
Can be null
paymentConfirmationSecondaryTextLoggedInstring
Can be null
headerColorstring
Can be null
headerTextColorstring
Can be null
primaryButtonColorstring
Can be null
primaryButtonHoverColorstring
Can be null
primaryButtonTextColorstring
Can be null
primaryStepColorstring
Can be null
onboardingFlowboolean
invoiceLogostring
Can be null
allowedDaysAfterExpirynumber
minimum: 0
onNewUserCompletedPackageIdnumber
Can be null
allowBuyNewSubsFromMypageboolean
allowBuyGiftSubsFromMypageboolean
onNewUserCompletedNewsletterAndConsentboolean
showBuyNewSubscriptionCTAboolean
buyNewSubscriptionPackageIdnumber
Can be null
showPodcastSearchboolean
eInvoicePaymentPreferenceEInvoicePaymentPreferenceRequired8 fields
eInvoicePaymentPreference
- initialActivationINITIAL_ACTIVATIONRequiredField path: eInvoicePaymentPreference.initialActivation
  Allowed values: "ON_PAYMENT", "ON_ORDER"
- dueDaysAfterOrderForInitialnumberRequiredField path: eInvoicePaymentPreference.dueDaysAfterOrderForInitial
- initialDeactivationDEACTIVATION_POLICYRequiredField path: eInvoicePaymentPreference.initialDeactivation
  Allowed values: "ON_DUE", "ON_RENEWAL", "NEVER"
checkoutWelcomeCTAConfigCheckoutWelcomeCTAConfigRequired3 fields
checkoutWelcomeCTAConfig
- defaultbooleanRequiredField path: checkoutWelcomeCTAConfig.default
- primaryCheckoutWelcomeCTAButtonConfigRequiredField path: checkoutWelcomeCTAConfig.primary3 fields
  checkoutWelcomeCTAConfig.primary
  - textTranslationRequiredField path: checkoutWelcomeCTAConfig.primary.textNested fields omitted: depth limit.
  - urlstringRequiredField path: checkoutWelcomeCTAConfig.primary.url
giftSubscriptionConfirmationTextLoggedInstring
Can be null
giftSubscriptionWelcomeHelpTextstring
Can be null
systemUpgradeNotificationTranslationRequiredCan be null5 fields
systemUpgradeNotification
- enstringRequired when parent is presentField path: systemUpgradeNotification.en
- nostringRequired when parent is presentField path: systemUpgradeNotification.no
- svstringField path: systemUpgradeNotification.sv
- dastringField path: systemUpgradeNotification.da
- keystringField path: systemUpgradeNotification.key
orderCtaLabelTranslationCan be null5 fields
orderCtaLabel
- enstringRequired when parent is presentField path: orderCtaLabel.en
- nostringRequired when parent is presentField path: orderCtaLabel.no
- svstringField path: orderCtaLabel.sv
- dastringField path: orderCtaLabel.da
- keystringField path: orderCtaLabel.key
inputFieldConfigarray of PageInputFieldConfigRequired3 fields
inputFieldConfig
- pagestringRequired when parent is presentField path: inputFieldConfig[].page
- systemFieldsarray of SystemFieldConfigRequired when parent is presentField path: inputFieldConfig[].systemFieldsNested fields omitted: field limit.
- customPropertiesarray of stringRequired when parent is presentField path: inputFieldConfig[].customProperties
maintenanceModeConfigMaintenanceModeConfigRequiredCan be null2 fields
maintenanceModeConfig
- enabledbooleanRequired when parent is presentField path: maintenanceModeConfig.enabled
- globalMessageGlobalMessageRequired when parent is presentField path: maintenanceModeConfig.globalMessageNested fields omitted: field limit.
permissionLevelForBuyingMultipleSubscriptionsPermissionLevelForBuyingMultipleSubscriptionsRequired
Allowed values: "allow", "warn", "block"
themeThemeConfigCan be null1 field
theme
- typographyTypographyConfigRequired when parent is presentField path: theme.typographyNested fields omitted: field limit.
customFieldsOnMemberCardarray of string
visibleAdditionalFieldsOnMypagearray of stringRequired
customFieldsOnInvoicearray of CustomFieldsOnInvoiceDtoRequiredCan be null2 fields
customFieldsOnInvoice
- paymentProviderPaymentProviderRequired when parent is presentField path: customFieldsOnInvoice[].paymentProvider
  Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
- propertiesarray of PropertiesConfigRequired when parent is presentField path: customFieldsOnInvoice[].propertiesNested fields omitted: field limit.
myPagePackageSortMyPagePackageSortConfigRequired2 fields
myPagePackageSort
- modeMyPagePackageSortModeRequiredField path: myPagePackageSort.mode
  Allowed values: "name", "custom"
- directionMyPagePackageSortDirectionRequiredField path: myPagePackageSort.direction
  Allowed values: "asc", "desc"

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

Schema ExamplePreferenceResponseDto

200 · application/json

Responses 400

Status200 400 401 403 404 500application/json

Body validation failed or the id is not an integer; field codes in errors[]

Schema ExampleErrorResponse

Same fields as Get all tenants (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get tenants settings (403).

Responses 404

Status200 400 401 403 404 500application/json

tenantNotFound, tenantPreferenceNotFound

Schema ExampleErrorResponse

Same fields as Update a tenant settings (404).

Schema ExampleErrorResponse

404 · application/json

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

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/tenants/{id}/preference' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "welcomeImage": "string",
  "headerText": "string",
  "headerLogoHeight": 1,
  "welcomePrimaryText": "string",
  "welcomeSecondaryText": "string",
  "memberInfoText": "string",
  "paymentConfirmationImage": "string",
  "subscriptionChangeCompleteScreenImage": "string",
  "paymentConfirmationPrimaryText": "string",
  "paymentConfirmationSecondaryTextLoggedOut": "string",
  "paymentConfirmationSecondaryTextLoggedIn": "string",
  "headerColor": "string",
  "headerTextColor": "string",
  "primaryButtonColor": "string",
  "primaryButtonHoverColor": "string",
  "primaryButtonTextColor": "string",
  "primaryStepColor": "string",
  "onboardingFlow": true,
  "invoiceLogo": "string",
  "allowedDaysAfterExpiry": 0,
  "onNewUserCompletedPackageId": 0,
  "allowBuyNewSubsFromMypage": true,
  "allowBuyGiftSubsFromMypage": true,
  "onNewUserCompletedNewsletterAndConsent": true,
  "showBuyNewSubscriptionCTA": true,
  "buyNewSubscriptionPackageId": 0,
  "showPodcastSearch": true,
  "eInvoicePaymentPreference": {
    "initialActivation": "ON_PAYMENT",
    "dueDaysAfterOrderForInitial": 0,
    "initialDeactivation": "ON_DUE",
    "initialOnDueDeactivationBufferDays": 0,
    "orderDaysBeforeRenewal": 0,
    "dueDaysAfterOrderForRecurring": 0,
    "recurringDeactivation": "ON_DUE",
    "recurringOnDueDeactivationBufferDays": 0
  },
  "checkoutWelcomeCTAConfig": {
    "default": true,
    "primary": {},
    "secondary": {}
  },
  "giftSubscriptionConfirmationTextLoggedIn": "string",
  "giftSubscriptionWelcomeHelpText": "string",
  "systemUpgradeNotification": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "inputFieldConfig": [
    {
      "systemFields": [],
      "customProperties": []
    }
  ],
  "maintenanceModeConfig": {
    "enabled": true,
    "globalMessage": {}
  },
  "permissionLevelForBuyingMultipleSubscriptions": "allow",
  "theme": {
    "typography": {}
  },
  "customFieldsOnMemberCard": [
    "string"
  ],
  "visibleAdditionalFieldsOnMypage": [
    "string"
  ],
  "customFieldsOnInvoice": [
    {
      "properties": []
    }
  ],
  "myPagePackageSort": {
    "mode": "name",
    "direction": "asc"
  }
}'

Try it

Send a real request to api.subrite.no from your browser. Your token is only kept in this tab, until you reload or close it.

PATCH https://api.subrite.no/api/v1/tenants/{id}/preference

Bearer token · Required

id path · Required

Request body (JSON)

{
  "welcomeImage": "string",
  "headerText": "string",
  "headerLogoHeight": 1,
  "welcomePrimaryText": "string",
  "welcomeSecondaryText": "string",
  "memberInfoText": "string",
  "paymentConfirmationImage": "string",
  "subscriptionChangeCompleteScreenImage": "string",
  "paymentConfirmationPrimaryText": "string",
  "paymentConfirmationSecondaryTextLoggedOut": "string",
  "paymentConfirmationSecondaryTextLoggedIn": "string",
  "headerColor": "string",
  "headerTextColor": "string",
  "primaryButtonColor": "string",
  "primaryButtonHoverColor": "string",
  "primaryButtonTextColor": "string",
  "primaryStepColor": "string",
  "onboardingFlow": true,
  "invoiceLogo": "string",
  "allowedDaysAfterExpiry": 0,
  "onNewUserCompletedPackageId": 0,
  "allowBuyNewSubsFromMypage": true,
  "allowBuyGiftSubsFromMypage": true,
  "onNewUserCompletedNewsletterAndConsent": true,
  "showBuyNewSubscriptionCTA": true,
  "buyNewSubscriptionPackageId": 0,
  "showPodcastSearch": true,
  "eInvoicePaymentPreference": {
    "initialActivation": "ON_PAYMENT",
    "dueDaysAfterOrderForInitial": 0,
    "initialDeactivation": "ON_DUE",
    "initialOnDueDeactivationBufferDays": 0,
    "orderDaysBeforeRenewal": 0,
    "dueDaysAfterOrderForRecurring": 0,
    "recurringDeactivation": "ON_DUE",
    "recurringOnDueDeactivationBufferDays": 0
  },
  "checkoutWelcomeCTAConfig": {
    "default": true,
    "primary": {},
    "secondary": {}
  },
  "giftSubscriptionConfirmationTextLoggedIn": "string",
  "giftSubscriptionWelcomeHelpText": "string",
  "systemUpgradeNotification": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "inputFieldConfig": [
    {
      "systemFields": [],
      "customProperties": []
    }
  ],
  "maintenanceModeConfig": {
    "enabled": true,
    "globalMessage": {}
  },
  "permissionLevelForBuyingMultipleSubscriptions": "allow",
  "theme": {
    "typography": {}
  },
  "customFieldsOnMemberCard": [
    "string"
  ],
  "visibleAdditionalFieldsOnMypage": [
    "string"
  ],
  "customFieldsOnInvoice": [
    {
      "properties": []
    }
  ],
  "myPagePackageSort": {
    "mode": "name",
    "direction": "asc"
  }
}

TenantDetailsResponse

41 top-level fieldsSelect an object to expand

isOnboardingbooleanRequired
Onboarding mode. The member-facing site is replaced by the maintenance screen while true, because the imported data is still being validated. The admin route group is not gated, so the onboarding team and the customer admins keep full access.
marketstringRequired
Operating market of the tenant.Allowed values: "NO", "SE", "DK"
productNamestring
Product name for the tenantAllowed values: "enterprise", "communication", "custom"
additionalFeaturesarray of string
Field details
Additional features enabled for the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting", "invoices", "ai"
disabledFeaturesarray of string
Field details
Features disabled for the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting", "invoices", "ai"
featuresMapobjectRequired12 fields
featuresMap
- emailobjectField path: featuresMap.email2 fields
  featuresMap.email
  - enabledbooleanField path: featuresMap.email.enabled
  - upgradablebooleanField path: featuresMap.email.upgradable
- smsobjectField path: featuresMap.sms2 fields
  featuresMap.sms
  - enabledboolean
idnumberRequired
namestringRequired
isActivebooleanRequired
defaultLanguagestringRequired
Allowed values: "en", "no", "sv", "da"
hostNamestringRequired
logostringRequired
faviconstringRequired
authLogostringRequired
authLogoHeightnumberRequired
Can be null
siteUrlstringRequired
termsUrlstringRequired
privacyUrlstringRequired
gtmstringRequired
taxRatesarray of number
tenantContactstringRequired
defaultLogoutURLstringRequired
postalAddressstringRequired
preferencePreferenceResponseDtoRequiredNested fields omitted: field limit.
settingsTenantSettingsResponseDtoRequired20 fields
settings
- kilkayaEnabledbooleanRequiredField path: settings.kilkayaEnabled
- kilkayaHoststringRequiredField path: settings.kilkayaHost
  Can be null
- kilkayaCustomerIdstringRequiredField path: settings.kilkayaCustomerId
  Can be null
- discardTopicsInPushNotificationsbooleanRequiredField path: settings.discardTopicsInPushNotifications
oauthProvidersarray of PublicOAuthProviderRequired3 fields
oauthProviders
- idstringRequired when parent is presentField path: oauthProviders[].id
- clientIdstringRequired when parent is presentField path: oauthProviders[].clientId
- namestringRequired when parent is presentField path: oauthProviders[].name
emailProviderstringRequired
Allowed values: "brevo", "sendgrid"
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
addressAddressNested fields omitted: field limit.
otpTemplateIdTranslationNested fields omitted: field limit.
brandKitIdstring
smsOtpbooleanRequired
smsSenderIdnumber
smsSenderCommunicationSenderResponseDtoNested fields omitted: field limit.
emailSenderIdnumber
emailSenderCommunicationSenderResponseDtoNested fields omitted: field limit.
emailOtpEnabledbooleanRequired
smsOtpEnabledbooleanRequired
smsOtpFallbackEnabledbooleanRequired
primaryOtpChannelstringRequired
Allowed values: "email", "sms"

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

Schema ExampleTenantDetailsResponse

200 · application/json

{
  "isOnboarding": true,
  "market": "NO",
  "productName": "enterprise",
  "additionalFeatures": [
    "email"
  ],
  "disabledFeatures": [
    "email"
  ],
  "featuresMap": {
    "email": {},
    "sms": {},
    "push": {},
    "podcasts": {},
    "subscription": {},
    "insights": {},
    "dashboard": {},
    "automation": {},
    "export": {},
    "accounting": {},
    "invoices": {},
    "ai": {},
    "property1": {},
    "property2": {}
  },
  "id": 0,
  "name": "string",
  "isActive": true,
  "defaultLanguage": "en",
  "hostName": "string",
  "logo": "string",
  "favicon": "string",
  "authLogo": "string",
  "authLogoHeight": 0,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "gtm": "string",
  "taxRates": [
    0
  ],
  "tenantContact": "string",
  "defaultLogoutURL": "string",
  "postalAddress": "<postalAddress>",
  "preference": {
    "welcomeImage": "string",
    "headerText": "string",
    "headerLogoHeight": 1,
    "welcomePrimaryText": "string",
    "welcomeSecondaryText": "string",
    "memberInfoText": "string",
    "paymentConfirmationImage": "string",
    "subscriptionChangeCompleteScreenImage": "string",
    "paymentConfirmationPrimaryText": "string",
    "paymentConfirmationSecondaryTextLoggedOut": "string",
    "paymentConfirmationSecondaryTextLoggedIn": "string",
    "headerColor": "string",
    "headerTextColor": "string",
    "primaryButtonColor": "string",
    "primaryButtonHoverColor": "string",
    "primaryButtonTextColor": "string",
    "primaryStepColor": "string",
    "onboardingFlow": true,
    "invoiceLogo": "string",
    "allowedDaysAfterExpiry": 0,
    "onNewUserCompletedPackageId": 0,
    "allowBuyNewSubsFromMypage": true,
    "allowBuyGiftSubsFromMypage": true,
    "onNewUserCompletedNewsletterAndConsent": true,
    "showBuyNewSubscriptionCTA": true,
    "buyNewSubscriptionPackageId": 0,
    "showPodcastSearch": true,
    "eInvoicePaymentPreference": {},
    "checkoutWelcomeCTAConfig": {},
    "giftSubscriptionConfirmationTextLoggedIn": "string",
    "giftSubscriptionWelcomeHelpText": "string",
    "systemUpgradeNotification": {},
    "orderCtaLabel": {},
    "inputFieldConfig": [],
    "maintenanceModeConfig": {},
    "permissionLevelForBuyingMultipleSubscriptions": "allow",
    "theme": {},
    "customFieldsOnMemberCard": [],
    "visibleAdditionalFieldsOnMypage": [],
    "customFieldsOnInvoice": [],
    "myPagePackageSort": {}
  },
  "settings": {
    "kilkayaEnabled": true,
    "kilkayaHost": "string",
    "kilkayaCustomerId": "string",
    "discardTopicsInPushNotifications": true,
    "aiResidency": {},
    "isOnboarding": true,
    "wentLiveAt": "2019-08-24T14:15:22Z",
    "emailOtpEnabled": true,
    "smsOtpEnabled": true,
    "smsOtpFallbackEnabled": true,
    "primaryOtpChannel": "email",
    "diEnabled": true,
    "diCustomerSystem": "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": {}
  },
  "oauthProviders": [
    {}
  ],
  "emailProvider": "brevo",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "address": {
    "entityId": "string",
    "entity": "string",
    "companyName": "string",
    "organizationNo": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "addressType": "primary",
    "name": "string",
    "email": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "route": "string",
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "brandKitId": "string",
  "smsOtp": true,
  "smsSenderId": 0,
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "emailSenderId": 0,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email"
}

Example · 208 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The path segment is not a registrable hostname

Schema ExampleErrorResponse

Same fields as Get a tenant by id (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

tenantNotFound

Schema ExampleErrorResponse

Same fields as Get tenants settings (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

brandKitBrandKitResponseDto26 fields

[].brandKit

idstringRequired when parent is presentField path: [].brandKit.id
namestringRequired when parent is presentField path: [].brandKit.name
maxLength: 255
smsOtpbooleanField path: [].brandKit.smsOtp
emailOtpEnabledbooleanField path: [].brandKit.emailOtpEnabled
smsOtpEnabledbooleanField path: [].brandKit.smsOtpEnabled
smsOtpFallbackEnabledbooleanField path: [].brandKit.smsOtpFallbackEnabled
primaryOtpChannelstringField path: [].brandKit.primaryOtpChannel
Allowed values: "email", "sms"
faviconstringField path: [].brandKit.favicon
authLogostringField path: [].brandKit.authLogo
authLogoHeightnumberField path: [].brandKit.authLogoHeight
minimum: 1maximum: 500
siteUrlstringField path: [].brandKit.siteUrl
termsUrlstringField path: [].brandKit.termsUrl
privacyUrlstringField path: [].brandKit.privacyUrl
defaultLogoutUrlstringField path: [].brandKit.defaultLogoutUrl
pageHeaderPageHeaderConfigField path: [].brandKit.pageHeader5 fields
[].brandKit.pageHeader
- logostringRequired when parent is presentField path: [].brandKit.pageHeader.logo
- logoHeightnumberRequired when parent is presentField path: [].brandKit.pageHeader.logoHeight
- textContentstringRequired when parent is presentField path: [].brandKit.pageHeader.textContent
- textColorstringRequired when parent is presentField path: [].brandKit.pageHeader.textColor
- bgColor
primaryButtonButtonConfigField path: [].brandKit.primaryButton4 fields
[].brandKit.primaryButton
- bgColorstringRequired when parent is presentField path: [].brandKit.primaryButton.bgColor
- textColorstringRequired when parent is presentField path: [].brandKit.primaryButton.textColor
- hoverColorstringRequired when parent is presentField path: [].brandKit.primaryButton.hoverColor
- stepColorstringRequired when parent is presentField path: [].brandKit.primaryButton.stepColor
primaryFontBrandKitFontConfigField path: [].brandKit.primaryFont6 fields
[].brandKit.primaryFont
- familystringRequired when parent is presentField path: [].brandKit.primaryFont.family
- urlstringRequired when parent is presentField path: [].brandKit.primaryFont.url
- typestringRequired when parent is presentField path: [].brandKit.primaryFont.type
- stylestringRequired when parent is presentField path: [].brandKit.primaryFont.style
- displaystring
secondaryFontBrandKitFontConfigField path: [].brandKit.secondaryFont6 fields
[].brandKit.secondaryFont
- familystringRequired when parent is presentField path: [].brandKit.secondaryFont.family
- urlstringRequired when parent is presentField path: [].brandKit.secondaryFont.url
- typestringRequired when parent is presentField path: [].brandKit.secondaryFont.type
- stylestringRequired when parent is presentField path: [].brandKit.secondaryFont.style
- display
otpTemplateIdTranslationField path: [].brandKit.otpTemplateId5 fields
[].brandKit.otpTemplateId
- enstringRequired when parent is presentField path: [].brandKit.otpTemplateId.en
- nostringRequired when parent is presentField path: [].brandKit.otpTemplateId.no
- svstringField path: [].brandKit.otpTemplateId.sv
- dastringField path: [].brandKit.otpTemplateId.da
- keystringField path: [].brandKit.otpTemplateId.key
tenantIdnumberRequired when parent is presentField path: [].brandKit.tenantId
smsSenderIdnumberField path: [].brandKit.smsSenderId
emailSenderIdnumberField path: [].brandKit.emailSenderId
isDefaultbooleanRequired when parent is presentField path: [].brandKit.isDefault
emailSenderCommunicationSenderResponseDtoField path: [].brandKit.emailSender8 fields
[].brandKit.emailSender
- idnumberRequired when parent is presentField path: [].brandKit.emailSender.id
- senderNamestringRequired when parent is presentField path: [].brandKit.emailSender.senderName
- senderEmailstringRequired when parent is presentField path: [].brandKit.emailSender.senderEmail
- replyTostringRequired when parent is presentField path: [].brandKit.emailSender.replyTo
- status
smsSenderCommunicationSenderResponseDtoField path: [].brandKit.smsSender8 fields
[].brandKit.smsSender
- idnumberRequired when parent is presentField path: [].brandKit.smsSender.id
- senderNamestringRequired when parent is presentField path: [].brandKit.smsSender.senderName
- senderEmailstringRequired when parent is presentField path: [].brandKit.smsSender.senderEmail
- replyTostringRequired when parent is presentField path: [].brandKit.smsSender.replyTo
- statusCOMMUNICATION_SENDER_STATUS
hostnamesarray of TenantAdditionalHostnameDtoRequired when parent is presentField path: [].brandKit.hostnamesRecursive schema; nested fields are not repeated.

Schema Examplearray of TenantAdditionalHostnameDto

200 · application/json

[
  {
    "id": 0,
    "hostName": "string",
    "tenantId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "brandKitId": "string",
    "brandKit": {
      "hostnames": []
    }
  }
]

Example · 13 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

array of TenantAdditionalHostnameDto

Schema Examplearray of TenantAdditionalHostnameDto

200 · application/json

[
  {
    "id": 0,
    "hostName": "string",
    "tenantId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "brandKitId": "string",
    "brandKit": {
      "hostnames": []
    }
  }
]

Example · 13 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The id is not an integer

Schema ExampleErrorResponse

Same fields as Get a tenant by id (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 Get tenants settings (403).

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

tenantNotFound

Schema ExampleErrorResponse

Same fields as Get tenants settings (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleNewTenantAdditionalHostnameDto

application/json

{
  "hostName": "string",
  "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0"
}

Example · 4 linesShow full heightShow compact view

Responses

7 status codes

Responses 201

Status201 400 401 403 404 409 500application/json

Schema Examplearray of TenantAdditionalHostnameDto

7 top-level fieldsSelect an object to expand

idnumberRequired when parent is present
hostNamestringRequired when parent is present
tenantIdnumberRequired when parent is present
createdAtstring (date-time)Required when parent is present
updatedAtstring (date-time)Required when parent is present
brandKitIdstringRequired when parent is present
brandKitBrandKitResponseDto26 fields
[].brandKit
- idstringRequired when parent is presentField path: [].brandKit.id
- namestringRequired when parent is presentField path: [].brandKit.name
  maxLength: 255
- smsOtpbooleanField path: [].brandKit.smsOtp
- emailOtpEnabledbooleanField path: [].brandKit.emailOtpEnabled
- smsOtpEnabledbooleanField path: [].brandKit.smsOtpEnabled

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

Schema Examplearray of TenantAdditionalHostnameDto

201 · application/json

[
  {
    "id": 0,
    "hostName": "string",
    "tenantId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "brandKitId": "string",
    "brandKit": {
      "hostnames": []
    }
  }
]

Example · 13 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 409 500application/json

Body validation failed or the id is not an integer; mustBeAValidDomainName arrives in errors[] against hostName

Schema ExampleErrorResponse

Same fields as Get all tenants (400).

Schema ExampleErrorResponse

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 409 500application/json

tenantNotFound

Schema ExampleErrorResponse

Same fields as Get tenants settings (404).

Schema ExampleErrorResponse

404 · application/json

Responses 409

Status201 400 401 403 404 409 500application/json

The hostname is already registered; the code arrives in errors[] against hostName

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "hostnameAlreadyInUse"
messagestring

Responses 500

Status201 400 401 403 404 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/tenants/additional-hostname/{id}' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hostName": "string",
  "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0"
}'

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema Examplearray of TenantAdditionalHostnameDto

7 top-level fieldsSelect an object to expand

idnumberRequired when parent is present
hostNamestringRequired when parent is present
tenantIdnumberRequired when parent is present
createdAtstring (date-time)Required when parent is present
updatedAtstring (date-time)Required when parent is present
brandKitIdstringRequired when parent is present
brandKitBrandKitResponseDto26 fields
[].brandKit
- idstringRequired when parent is presentField path: [].brandKit.id
- namestringRequired when parent is presentField path: [].brandKit.name
  maxLength: 255
- smsOtpbooleanField path: [].brandKit.smsOtp
- emailOtpEnabledbooleanField path: [].brandKit.emailOtpEnabled
- smsOtpEnabledbooleanField path: [].brandKit.smsOtpEnabled

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

Schema Examplearray of TenantAdditionalHostnameDto

200 · application/json

[
  {
    "id": 0,
    "hostName": "string",
    "tenantId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "brandKitId": "string",
    "brandKit": {
      "hostnames": []
    }
  }
]

Example · 13 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

Body validation failed or the id is not an integer; field codes in errors[]

Schema ExampleErrorResponse

Same fields as Get all tenants (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 Get tenants settings (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500application/json

tenantNotFound, hostnameNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "tenantNotFound", "hostnameNotFound"
messagestring

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/tenants/additional-hostname/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hostName": "string"
}'

Schema ExampleUpdateTenantAdditionalHostnameDto

application/json

{
  "newHostName": "string",
  "hostName": "string",
  "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0"
}

Example · 5 linesShow full heightShow compact view

Responses

7 status codes

Responses 200

Status200 400 401 403 404 409 500application/json

Schema Examplearray of TenantAdditionalHostnameDto

7 top-level fieldsSelect an object to expand

idnumberRequired when parent is present
hostNamestringRequired when parent is present
tenantIdnumberRequired when parent is present
createdAtstring (date-time)Required when parent is present
updatedAtstring (date-time)Required when parent is present
brandKitIdstringRequired when parent is present
brandKitBrandKitResponseDto26 fields
[].brandKit
- idstringRequired when parent is presentField path: [].brandKit.id
- namestringRequired when parent is presentField path: [].brandKit.name
  maxLength: 255
- smsOtpbooleanField path: [].brandKit.smsOtp
- emailOtpEnabledbooleanField path: [].brandKit.emailOtpEnabled
- smsOtpEnabledbooleanField path: [].brandKit.smsOtpEnabled

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

Schema Examplearray of TenantAdditionalHostnameDto

200 · application/json

[
  {
    "id": 0,
    "hostName": "string",
    "tenantId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "brandKitId": "string",
    "brandKit": {
      "hostnames": []
    }
  }
]

Example · 13 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 409 500application/json

Body validation failed or the id is not an integer; mustBeAValidDomainName arrives in errors[] against hostName or newHostName

Schema ExampleErrorResponse

Same fields as Get all tenants (400).

Schema ExampleErrorResponse

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get tenants settings (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 409 500application/json

tenantNotFound, hostnameNotFound

Schema ExampleErrorResponse

Same fields as Remove additional hostname of a tenant (404).

Schema ExampleErrorResponse

Responses 409

Status200 400 401 403 404 409 500application/json

The new hostname is already registered; the code arrives in errors[] against newHostName

Schema ExampleErrorResponse

Same fields as Add additional hostname to a tenant (409).

Schema ExampleErrorResponse

Responses 500

Status200 400 401 403 404 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get tenants settings (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/tenants/additional-hostname/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "newHostName": "string",
  "hostName": "string",
  "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0"
}'

Schema ExampleErrorResponse

409 · application/json

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

Example · 7 linesShow full heightShow compact view

"invalidFileType"

, "imageOrRemovalFlagRequired"

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

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

Schema ExampleErrorResponse

502 · application/json

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

Example · 7 linesShow full heightShow compact view

, "fontFileRequired"

, "fontConfigInvalid"

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

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

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

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

{
  "welcomeImage": "string",
  "headerText": "string",
  "headerLogoHeight": 1,
  "welcomePrimaryText": "string",
  "welcomeSecondaryText": "string",
  "memberInfoText": "string",
  "paymentConfirmationImage": "string",
  "subscriptionChangeCompleteScreenImage": "string",
  "paymentConfirmationPrimaryText": "string",
  "paymentConfirmationSecondaryTextLoggedOut": "string",
  "paymentConfirmationSecondaryTextLoggedIn": "string",
  "headerColor": "string",
  "headerTextColor": "string",
  "primaryButtonColor": "string",
  "primaryButtonHoverColor": "string",
  "primaryButtonTextColor": "string",
  "primaryStepColor": "string",
  "onboardingFlow": true,
  "invoiceLogo": "string",
  "allowedDaysAfterExpiry": 0,
  "onNewUserCompletedPackageId": 0,
  "allowBuyNewSubsFromMypage": true,
  "allowBuyGiftSubsFromMypage": true,
  "onNewUserCompletedNewsletterAndConsent": true,
  "showBuyNewSubscriptionCTA": true,
  "buyNewSubscriptionPackageId": 0,
  "showPodcastSearch": true,
  "eInvoicePaymentPreference": {
    "initialActivation": "ON_PAYMENT",
    "dueDaysAfterOrderForInitial": 0,
    "initialDeactivation": "ON_DUE",
    "initialOnDueDeactivationBufferDays": 0,
    "orderDaysBeforeRenewal": 0,
    "dueDaysAfterOrderForRecurring": 0,
    "recurringDeactivation": "ON_DUE",
    "recurringOnDueDeactivationBufferDays": 0
  },
  "checkoutWelcomeCTAConfig": {
    "default": true,
    "primary": {},
    "secondary": {}
  },
  "giftSubscriptionConfirmationTextLoggedIn": "string",
  "giftSubscriptionWelcomeHelpText": "string",
  "systemUpgradeNotification": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "inputFieldConfig": [
    {
      "systemFields": [],
      "customProperties": []
    }
  ],
  "maintenanceModeConfig": {
    "enabled": true,
    "globalMessage": {}
  },
  "permissionLevelForBuyingMultipleSubscriptions": "allow",
  "theme": {
    "typography": {}
  },
  "customFieldsOnMemberCard": [
    "string"
  ],
  "visibleAdditionalFieldsOnMypage": [
    "string"
  ],
  "customFieldsOnInvoice": [
    {
      "properties": []
    }
  ],
  "myPagePackageSort": {
    "mode": "name",
    "direction": "asc"
  }
}

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

string

COMMUNICATION_SENDER_STATUS

primaryOtpChannel

string

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

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

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

Schema ExampleErrorResponse

409 · application/json

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

Example · 7 linesShow full heightShow compact view

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

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

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

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

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

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

Get tenants settings#

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 500

Update a tenant settings#

Request body

Upload a tenant settings image#

Request body

Upload a tenant settings font#

Request body

Get all tenants#

Parameters

Get a tenant by id#

Parameters

Responses

Responses 200

Update a tenant#

Parameters

Request body

Update a tenants preferences#

Parameters

Request body

Get a tenant details by hostname#

Parameters

Responses

Responses 200

Get all available hostnames. (Not occupied by any brand kit)#

Responses

Responses 200

Get additional hostnames of a tenant#

Parameters

Responses

Responses 200

Add additional hostname to a tenant#

Parameters

Request body

Remove additional hostname of a tenant#

Parameters

Request body

Update additional hostname of a tenant#

Parameters

Request body

Get tenants settings#

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 500

Update a tenant settings#

Request body

Upload a tenant settings image#

Request body

Upload a tenant settings font#

Request body

Get all tenants#

Parameters

Get a tenant by id#

Parameters

Responses

Responses 200

Update a tenant#

Parameters

Request body

Update a tenants preferences#

Parameters

Request body

Get a tenant details by hostname#

Parameters

Responses

Responses 200

Get all available hostnames. (Not occupied by any brand kit)#

Responses

Responses 200

Get additional hostnames of a tenant#

Parameters

Responses