Newsletter
Endpoints for Newsletter
ReferenceView as Markdown
Endpoints for Newsletter
GET/api/v1/newsletters/providers
Authentication: Bearer token (JWT)
unauthorized
forbiddenResource
internalServerError
curlcurl https://api.subrite.no/api/v1/newsletters/providers \
--header 'Authorization: Bearer <token>'POST/api/v1/newsletters/lists
Authentication: Bearer token (JWT)
application/jsonPOST/api/v1/newsletters
Authentication: Bearer token (JWT)
application/jsonDELETE/api/v1/newsletters/{id}
Authentication: Bearer token (JWT)
idnumberRequiredfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorTypepasswordstringRequiredintegrationIdstringOptionalunauthorized
forbiddenResource
internalServerError
curlcurl https://api.subrite.no/api/v1/newsletters/lists \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"provider": "mailchimp",
"apiKey": "<apiKey>",
"userName": "<userName>",
"password": "<password>",
"integrationId": "string"
}'configidstringRequired when parent is presentField path: config.idnamestringRequired when parent is presentField path: config.namelistNamestringOptionalField path: config.listNamewebhookSecretstringRequired when parent is presentField path: config.webhookSecretapiKeystringRequired when parent is presentField path: config.apiKeyuserNamestringRequired when parent is presentField path: config.userNamepasswordstringRequired when parent is presentField path: config.passwordaccessTokenstringRequired when parent is presentField path: config.accessTokenrefreshTokenstringRequired when parent is presentField path: config.refreshTokenintegrationIdstringRequired when parent is presentField path: config.integrationIdshouldNotBeEmpty, invalidFormat, alreadyExists
unauthorized
forbiddenResource
internalServerError
curlcurl https://api.subrite.no/api/v1/newsletters \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "string",
"provider": "mailchimp",
"config": {
"id": "string",
"name": "string",
"listName": "string",
"webhookSecret": "<webhookSecret>",
"apiKey": "<apiKey>",
"userName": "<userName>",
"password": "<password>",
"accessToken": "<accessToken>",
"refreshToken": "<refreshToken>",
"integrationId": "string"
}
}'application/jsonbadRequest
unauthorized
forbiddenResource
notFound
internalServerError
curlcurl 'https://api.subrite.no/api/v1/newsletters/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'passwordstringRequiredField path: config.passwordaccessTokenstringRequiredField path: config.accessTokenrefreshTokenstringRequiredField path: config.refreshTokenintegrationIdstringRequiredField path: config.integrationIdshowOnMyPagebooleanRequired when parent is presentField path: consents[].showOnMyPagestatusbooleanRequired when parent is presentField path: consents[].statuspurposestringRequired when parent is presentField path: consents[].purpose"marketing_and_newsletter", "consent"frequencystringRequired when parent is presentField path: consents[].frequencydefaultSubscribedbooleanRequired when parent is presentField path: consents[].defaultSubscribedsortOrdernumberRequired when parent is presentField path: consents[].sortOrdervisibilitystringRequired when parent is presentField path: consents[].visibility"subscriber", "nonSubscriber", "all"newsletterProviderConfigNewsletterProviderConfigRequired when parent is presentField path: consents[].newsletterProviderConfig11 fieldsconsents[].newsletterProviderConfigproviderstringRequired when parent is presentField path: consents[].newsletterProviderConfig.provider"mailchimp", "make", "mailmojo"namestringRequired when parent is presentField path: consents[].newsletterProviderConfig.nametenantIdnumberRequired when parent is presentField path: consents[].newsletterProviderConfig.tenantIdconfigNewsletterConfigRequired when parent is presentField path: consents[].newsletterProviderConfig.configNested fields omitted: depth limit.tenantTenantRequired when parent is presentField path: consents[].newsletterProviderConfig.tenantNested fields omitted: depth limit.consentsarray of ConsentRequired when parent is presentField path: consents[].newsletterProviderConfig.consentsRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: consents[].newsletterProviderConfig.idcreatedAtstring (date-time)Required when parent is presentField path: consents[].newsletterProviderConfig.createdAtupdatedAtstring (date-time)Required when parent is presentField path: consents[].newsletterProviderConfig.updatedAtdeletedAtstring (date-time)Required when parent is presentField path: consents[].newsletterProviderConfig.deletedAtmetaDataobjectRequired when parent is presentField path: consents[].newsletterProviderConfig.metaDatanewsletterProviderConfigIdnumberRequired when parent is presentField path: consents[].newsletterProviderConfigIdtenantIdnumberRequired when parent is presentField path: consents[].tenantIdtenantTenantRequired when parent is presentField path: consents[].tenantNested fields omitted: field limit.communicationsarray of CommunicationRequired when parent is presentField path: consents[].communicationsNested fields omitted: field limit.idnumberRequired when parent is presentField path: consents[].idcreatedAtstring (date-time)Required when parent is presentField path: consents[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: consents[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: consents[].deletedAtmetaDataobjectRequired when parent is presentField path: consents[].metaData{
"provider": "mailchimp",
"name": "string",
"tenantId": 0,
"config": {
"id": "string",
"name": "string",
"listName": "string",
"webhookSecret": "<webhookSecret>",
"apiKey": "<apiKey>",
"userName": "<userName>",
"password": "<password>",
"accessToken": "<accessToken>",
"refreshToken": "<refreshToken>",
"integrationId": "string"
},
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"consents": [
{
"communications": [],
"metaData": {}
}
],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}