Communication consents | Subrite

Communication consents

Endpoints for Communication consents

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/consents

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of ConsentResponseDto

22 top-level fieldsSelect an object to expand

integrationIdstringRequired when parent is present
titlestringRequired when parent is present
descriptionstringRequired when parent is present
imagestringRequired when parent is present
showOnCheckoutPagebooleanRequired when parent is present
showOnMyPagebooleanRequired when parent is present
statusbooleanRequired when parent is present
purposestringRequired when parent is present

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

Schema Examplearray of ConsentResponseDto

200 · application/json

[
  {
    "integrationId": "string",
    "title": "string",
    "description": "string",
    "image": "string",
    "showOnCheckoutPage": true,
    "showOnMyPage": true,
    "status": true,
    "purpose": "marketing_and_newsletter",
    "frequency": "string",
    "defaultSubscribed": true,
    "sortOrder": 0,
    "visibility": "subscriber",
    "newsletterProviderConfig": {
      "consents": [],
      "metaData": {}
    },
    "newsletterProviderConfigId": 0,
    "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": {}
    },
    "communications": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Example requestcurl

curl

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

Try it

Create a new consent#

POST/api/v1/consents

Authentication: Bearer token (JWT)

Request body

Required bodymultipart/form-data

SchemaConsentDto

15 top-level fieldsSelect an object to expand

imagePreviewstringOptional
previousImageUrlstringOptional
imagefileOptional
imageUrlstring (uri)Optional

GET/api/v1/consents/unsubscribe/validate

Accepts an unsubscribe token as a query parameter and validates if the token is valid and not expired.

Authentication: Bearer token (JWT)

Parameters

Query parameters1

tokenstringRequired
The unsubscribe token to validate

Responses

6 status codes

Responses 200

Unsubscribe from newsletter and communications#

POST/api/v1/consents/unsubscribe

Accepts an unsubscribe token and processes the unsubscribe request.

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUnsubscribeTokenDto

1 top-level field

tokenstringRequired

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

GET/api/v1/consents/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleConsentResponseDto

Same fields as Create a new consent (201).

create consent and member and sync third party newsletter#

POST/api/v1/consents/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Request body

Required bodyapplication/json

Schema ExampleConsentRequestDto

3 top-level fields

emailstring (email)Required
status

DELETE/api/v1/consents/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 204

This response has no body.

Responses 400

PATCH/api/v1/consents/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodymultipart/form-data

SchemaUpdateConsentDto

16 top-level fieldsSelect an object to expand

imagePreviewstringOptional
previousImageUrlstringOptional

PATCH/api/v1/consents/{id}/transfer-integration

The integration id moves with the provider config, so provider webhooks and M2M callers posting to it keep working. The source consent gets a fresh integration id.

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleTransferConsentIntegrationDto

1 top-level field

GET/api/v1/consents/webhook/mailchimp/{webhooksecret}

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

Sync member consent from mailchimp#

POST/api/v1/consents/webhook/mailchimp/{webhooksecret}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

webhooksecretstringRequired

Responses

5 status codes

Responses 201

This response has no body.

Sync member consent from make#

POST/api/v1/consents/webhook/make/{webhooksecret}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

webhooksecretstringRequired

Responses

5 status codes

Responses 201

This response has no body.

PUT/api/v1/consents/bulk-sort-order

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaBulkUpdateConsentSortOrderDto

1 top-level fieldSelect an object to expand

consentsarray of ConsentSortOrderItemDtoRequired2 required when the containing object is present2 fields
consents
Array of consent IDs and their new sort orders
- idnumberRequired when parent is presentField path: consents[].id

GET/api/v1/consents/mailmojo/get-credentials/{integrationId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

integrationIdstringRequired

Responses

5 status codes

Responses 200

Status200 401 403 500 defaultapplication/json

GET/api/v1/consents/webhook/mailmojo/authorize

This endpoint receives the authorization code from Mailmojo after user authorization. It always answers with a page that posts MAILMOJO_AUTH_SUCCESS or MAILMOJO_AUTH_FAILED (with a messageCode) to the admin page that opened the authorization popup.

Authentication: Bearer token (JWT)

Parameters

Query parameters2

codestringOptional
statestringRequired

Responses

4 status codes

Responses 200

OAuth callback endpoint for Mailmojo#

POST/api/v1/consents/webhook/mailmojo/{webhooksecret}

This endpoint receives the authorization code from Mailmojo after user authorization

Authentication: Bearer token (JWT)

Parameters

Path parameters1

webhooksecretstringRequired

Responses

5 status codes

Responses 201

communicationsarray of CommunicationRequired when parent is present36 fields

[].communications

namestringRequired when parent is presentField path: [].communications[].name
statusstringRequired when parent is presentField path: [].communications[].status
Allowed values: "draft", "ready", "scheduled", "completed", "failed", "processing"
smsContentstringRequired when parent is presentField path: [].communications[].smsContent
subjectstringRequired when parent is presentField path: [].communications[].subject
emailEditorRawContentobjectRequired when parent is presentField path: [].communications[].emailEditorRawContent
communicationTypestringRequired when parent is presentField path: [].communications[].communicationType
Allowed values: "automation", "crm", "marketing", "otp", "information", "emailStandard", "jobCompletion", "oneOff"
communicationChannelstringRequired when parent is presentField path: [].communications[].communicationChannel
Allowed values: "sms", "email"
scheduledAtstring (date-time)Required when parent is presentField path: [].communications[].scheduledAt
completedAtstring (date-time)Required when parent is presentField path: [].communications[].completedAt
adminUserIdnumberRequired when parent is presentField path: [].communications[].adminUserId
tenantIdnumberRequired when parent is presentField path: [].communications[].tenantId
consentIdnumberRequired when parent is presentField path: [].communications[].consentId
segmentIdnumberRequired when parent is presentField path: [].communications[].segmentId
templateIdnumberRequired when parent is presentField path: [].communications[].templateId
emailPreviewTextstringRequired when parent is presentField path: [].communications[].emailPreviewText
deliveryMethodstringRequired when parent is presentField path: [].communications[].deliveryMethod
externalEmailBodystringRequired when parent is presentField path: [].communications[].externalEmailBody
emailHtmlPreviewstringRequired when parent is presentField path: [].communications[].emailHtmlPreview
hostNamestringRequired when parent is presentField path: [].communications[].hostName
Can be null
senderIdnumberRequired when parent is presentField path: [].communications[].senderId
totalRecipientsnumberRequired when parent is presentField path: [].communications[].totalRecipients
Can be null
totalPagesnumberRequired when parent is presentField path: [].communications[].totalPages
Can be null
audienceBasisstringRequired when parent is presentField path: [].communications[].audienceBasis
Can be null
customerWindowMonthsnumberRequired when parent is presentField path: [].communications[].customerWindowMonths
Can be null
senderCommunicationSenderRequired when parent is presentField path: [].communications[].senderNested fields omitted: field limit.
adminUserUserRequired when parent is presentField path: [].communications[].adminUserNested fields omitted: field limit.
tenantTenantRequired when parent is presentField path: [].communications[].tenantNested fields omitted: field limit.
consentConsentRequired when parent is presentField path: [].communications[].consentNested fields omitted: field limit.
segmentSegmentRequired when parent is presentField path: [].communications[].segmentNested fields omitted: field limit.
templateCommunicationTemplateRequired when parent is presentField path: [].communications[].templateNested fields omitted: field limit.
communicationLogsarray of CommunicationLogRequired when parent is presentField path: [].communications[].communicationLogsNested fields omitted: field limit.
idnumberRequired when parent is presentField path: [].communications[].id
createdAtstring (date-time)Required when parent is presentField path: [].communications[].createdAt
updatedAtstring (date-time)Required when parent is presentField path: [].communications[].updatedAt
deletedAtstring (date-time)Required when parent is presentField path: [].communications[].deletedAt
metaDataobjectRequired when parent is presentField path: [].communications[].metaData

field

string

Responses

7 status codes

Responses 201

Status201 400 401 403 413 415 500application/json

Schema ExampleConsentResponseDto

22 top-level fieldsSelect an object to expand

integrationIdstringRequired
titlestringRequired
descriptionstringRequired
imagestringRequired
showOnCheckoutPagebooleanRequired
showOnMyPagebooleanRequired
statusbooleanRequired
purposestringRequired
Allowed values: "marketing_and_newsletter", "consent"
frequencystringRequired
defaultSubscribedbooleanRequired
sortOrdernumberRequired
visibilitystringRequired
Allowed values: "subscriber", "nonSubscriber", "all"
newsletterProviderConfigNewsletterProviderConfigRequired11 fields
newsletterProviderConfig
- providerstringRequiredField path: newsletterProviderConfig.provider
  Allowed values: "mailchimp", "make", "mailmojo"
- namestringRequiredField path: newsletterProviderConfig.name
- tenantIdnumberRequiredField path: newsletterProviderConfig.tenantId
- configNewsletterConfigRequiredField path: newsletterProviderConfig.config10 fields
newsletterProviderConfigIdnumberRequired
tenantIdnumberRequired
tenantTenantRequiredNested fields omitted: field limit.
communicationsarray of CommunicationRequired36 fields
communications
- namestringRequired when parent is presentField path: communications[].name
- statusstringRequired when parent is presentField path: communications[].status
  Allowed values: "draft", "ready", "scheduled", "completed", "failed", "processing"
- smsContentstringRequired when parent is presentField path: communications[].smsContent
- subjectstringRequired when parent is presentField path: communications[].subject
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

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

Schema ExampleConsentResponseDto

201 · application/json

Responses 400

Status201 400 401 403 413 415 500application/json

badRequest, invalidExternalProviderConfig

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "invalidExternalProviderConfig"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 413 415 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 413

fileSizeExceeded

This response has no body.

Responses 415

invalidFileType

This response has no body.

Responses 500

Status201 400 401 403 413 415 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/consents \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --form 'image=@<file>' \
  --form 'purpose=marketing_and_newsletter' \
  --form 'title=string' \
  --form 'description=string' \
  --form 'status=true' \
  --form 'frequency=string' \
  --form 'showOnCheckoutPage=true' \
  --form 'showOnMyPage=true' \
  --form 'defaultSubscribed=true'

Responses 400

Status200 400 401 403 500 defaultapplication/json

invalidOrExpiredUnsubscribeToken, incompleteUnsubscribeTokenPayload, consentIsAlreadyUnsubscribed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "invalidOrExpiredUnsubscribeToken", "incompleteUnsubscribeTokenPayload", "consentIsAlreadyUnsubscribed"
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": "invalidOrExpiredUnsubscribeToken",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500 defaultapplication/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

UnsubscribeTokenDto

Responses

5 status codes

Responses 201

This response has no body.

Responses 400

Status201 400 401 403 500application/json

invalidOrExpiredUnsubscribeToken, incompleteUnsubscribeTokenPayload, consentIsAlreadyUnsubscribed

Schema ExampleErrorResponse

Same fields as Validate unsubscribe token (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/consents/unsubscribe \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "<token>"
}'

ConsentResponseDto

200 · application/json

{
  "integrationId": "string",
  "title": "string",
  "description": "string",
  "image": "string",
  "showOnCheckoutPage": true,
  "showOnMyPage": true,
  "status": true,
  "purpose": "marketing_and_newsletter",
  "frequency": "string",
  "defaultSubscribed": true,
  "sortOrder": 0,
  "visibility": "subscriber",
  "newsletterProviderConfig": {
    "provider": "mailchimp",
    "name": "string",
    "tenantId": 0,
    "config": {},
    "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": {}
    },
    "consents": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "newsletterProviderConfigId": 0,
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "communications": [
    {
      "emailEditorRawContent": {},
      "communicationLogs": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 153 linesShow full heightShow compact view

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

consentNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

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

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

string

Responses

5 status codes

Responses 201

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 417 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 417

Status201 401 403 417 500application/json

newsletterSyncFailed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "newsletterSyncFailed"
messagestring
errorsarray of FieldError

Responses 500

Status201 401 403 417 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/consents/{id}' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "status": "accepted",
  "reference": "string"
}'

application/json

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

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

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status204 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status204 400 401 403 404 500application/json

consentNotFound

Schema ExampleErrorResponse

Same fields as Get consent details (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

8 status codes

Responses 200

Status200 400 401 403 404 413 415 500application/json

Schema ExampleConsentResponseDto

Same fields as Create a new consent (201).

Schema ExampleConsentResponseDto

200 · application/json

{
  "integrationId": "string",
  "title": "string",
  "description": "string",
  "image": "string",
  "showOnCheckoutPage": true,
  "showOnMyPage": true,
  "status": true,
  "purpose": "marketing_and_newsletter",
  "frequency": "string",
  "defaultSubscribed": true,
  "sortOrder": 0,
  "visibility": "subscriber",
  "newsletterProviderConfig": {
    "provider": "mailchimp",
    "name": "string",
    "tenantId": 0,
    "config": {},
    "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": {}
    },
    "consents": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "newsletterProviderConfigId": 0,
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "communications": [
    {
      "emailEditorRawContent": {},
      "communicationLogs": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 153 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 413 415 500application/json

badRequest, invalidExternalProviderConfig

Schema ExampleErrorResponse

Same fields as Create a new consent (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 413 415 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 404

Status200 400 401 403 404 413 415 500application/json

consentNotFound

Schema ExampleErrorResponse

Same fields as Get consent details (404).

Schema ExampleErrorResponse

404 · application/json

Responses 413

fileSizeExceeded

This response has no body.

Responses 415

invalidFileType

This response has no body.

Responses 500

Status200 400 401 403 404 413 415 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Responses

6 status codes

Responses 200

Status200 401 403 404 409 500application/json

Schema ExampleConsentResponseDto

Same fields as Create a new consent (201).

Schema ExampleConsentResponseDto

200 · application/json

{
  "integrationId": "string",
  "title": "string",
  "description": "string",
  "image": "string",
  "showOnCheckoutPage": true,
  "showOnMyPage": true,
  "status": true,
  "purpose": "marketing_and_newsletter",
  "frequency": "string",
  "defaultSubscribed": true,
  "sortOrder": 0,
  "visibility": "subscriber",
  "newsletterProviderConfig": {
    "provider": "mailchimp",
    "name": "string",
    "tenantId": 0,
    "config": {},
    "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": {}
    },
    "consents": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "newsletterProviderConfigId": 0,
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "communications": [
    {
      "emailEditorRawContent": {},
      "communicationLogs": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 153 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 401 403 404 409 500application/json

consentsNotFoundOrAccessDenied

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "consentsNotFoundOrAccessDenied"
messagestring

Responses 409

Status200 401 403 404 409 500application/json

consentNotConnected, consentAlreadyConnected

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "consentNotConnected", "consentAlreadyConnected"
messagestring

Responses 500

Status200 401 403 404 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/consents/{id}/transfer-integration' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetConsentId": 2
}'

application/json

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

invalidWebhookSecret

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "invalidWebhookSecret"
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": "invalidWebhookSecret",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

Status201 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

Same fields as Sync member consent from mailchimp (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status201 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema Examplearray of ConsentResponseDto

22 top-level fieldsSelect an object to expand

integrationIdstringRequired when parent is present
titlestringRequired when parent is present
descriptionstringRequired when parent is present
imagestringRequired when parent is present
showOnCheckoutPagebooleanRequired when parent is present
showOnMyPagebooleanRequired when parent is present
statusbooleanRequired when parent is present
purposestringRequired when parent is present
Allowed values: "marketing_and_newsletter", "consent"
frequencystringRequired when parent is present
defaultSubscribedbooleanRequired when parent is present
sortOrdernumberRequired when parent is present
visibilitystringRequired when parent is present
Allowed values: "subscriber", "nonSubscriber", "all"
newsletterProviderConfigNewsletterProviderConfigRequired when parent is present11 fields
[].newsletterProviderConfig
- providerstringRequired when parent is presentField path: [].newsletterProviderConfig.provider
  Allowed values: "mailchimp", "make", "mailmojo"
- namestringRequired when parent is presentField path: [].newsletterProviderConfig.name
- tenantIdnumberRequired when parent is presentField path: [].newsletterProviderConfig.tenantId
- configNewsletterConfigRequired when parent is present
newsletterProviderConfigIdnumberRequired when parent is present
tenantIdnumberRequired when parent is present
tenantTenantRequired when parent is presentNested fields omitted: field limit.
communicationsarray of CommunicationRequired when parent is present36 fields
[].communications
- namestringRequired when parent is presentField path: [].communications[].name
- statusstringRequired when parent is presentField path: [].communications[].status
  Allowed values: "draft", "ready", "scheduled", "completed", "failed", "processing"
- smsContentstringRequired when parent is presentField path: [].communications[].smsContent
- subjectstringRequired when parent is presentField path: [].communications[].subject
idnumberRequired when parent is present
createdAtstring (date-time)Required when parent is present
updatedAtstring (date-time)Required when parent is present
deletedAtstring (date-time)Required when parent is present
metaDataobjectRequired when parent is present

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

Schema Examplearray of ConsentResponseDto

200 · application/json

[
  {
    "integrationId": "string",
    "title": "string",
    "description": "string",
    "image": "string",
    "showOnCheckoutPage": true,
    "showOnMyPage": true,
    "status": true,
    "purpose": "marketing_and_newsletter",
    "frequency": "string",
    "defaultSubscribed": true,
    "sortOrder": 0,
    "visibility": "subscriber",
    "newsletterProviderConfig": {
      "consents": [],
      "metaData": {}
    },
    "newsletterProviderConfigId": 0,
    "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": {}
    },
    "communications": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 404

Status200 401 403 404 500application/json

consentsNotFoundOrAccessDenied

Schema ExampleErrorResponse

Same fields as Move a consent's newsletter integration to another consent (404).

Schema ExampleErrorResponse

404 · application/json

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

Responses 500

Status200 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all consents (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/consents/bulk-sort-order \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "consents": [
    {}
  ]
}'

MailmojoCredentialsResponseDto

Schema ExampleMailmojoCredentialsResponseDto

200 · application/json

{
  "clientId": "string",
  "clientSecret": "<clientSecret>",
  "accessToken": "<accessToken>",
  "refreshToken": "<refreshToken>"
}

Example · 6 linesShow full heightShow compact view

Responses 403

Status200 401 403 500 defaultapplication/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

invalidWebhookSecret

Schema ExampleErrorResponse

Same fields as Sync member consent from mailchimp (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status201 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get all consents (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

{
  "integrationId": "string",
  "title": "string",
  "description": "string",
  "image": "string",
  "showOnCheckoutPage": true,
  "showOnMyPage": true,
  "status": true,
  "purpose": "marketing_and_newsletter",
  "frequency": "string",
  "defaultSubscribed": true,
  "sortOrder": 0,
  "visibility": "subscriber",
  "newsletterProviderConfig": {
    "provider": "mailchimp",
    "name": "string",
    "tenantId": 0,
    "config": {},
    "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": {}
    },
    "consents": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "newsletterProviderConfigId": 0,
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "communications": [
    {
      "emailEditorRawContent": {},
      "communicationLogs": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Schema ExampleErrorResponse

417 · application/json

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

Example · 7 linesShow full heightShow compact view

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

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

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

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

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

Example · 7 linesShow full heightShow compact view

Get all consents#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Create a new consent#

Request body

Validate unsubscribe token#

Parameters

Responses

Responses 200

Unsubscribe from newsletter and communications#

Request body

Get consent details#

Parameters

Responses

Responses 200

create consent and member and sync third party newsletter#

Parameters

Request body

Delete a consent#

Parameters

Responses

Responses 204

Responses 400

Update a consent#

Parameters

Request body

Move a consent's newsletter integration to another consent#

Parameters

Request body

Get mailchimp webhook validation#

Responses

Responses 200

Responses 401

Sync member consent from mailchimp#

Parameters

Responses

Responses 201

Sync member consent from make#

Parameters

Responses

Responses 201

Bulk update consent sort orders#

Request body

Get Mailmojo credentials#

Parameters

Responses

Responses 200

OAuth callback endpoint for Mailmojo#

Parameters

Responses

Responses 200

OAuth callback endpoint for Mailmojo#

Parameters

Responses

Responses 201

Get all consents#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Create a new consent#

Request body

Validate unsubscribe token#

Parameters

Responses

Responses 200

Unsubscribe from newsletter and communications#

Request body

Get consent details#

Parameters

Responses

Responses 200

create consent and member and sync third party newsletter#

Parameters

Request body

Delete a consent#