Push Notifications | Subrite

Push Notifications

Endpoints for Push Notifications

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/app-push/setup

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExamplePushSetupResponseDto

8 top-level fieldsSelect an object to expand

idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
providerstringRequired
Allowed values: "fcm"
providerCredentialsProviderCredentialsRequired11 fields
providerCredentials
- typestringRequiredField path: providerCredentials.type

Schema ExamplePushSetupResponseDto

200 · application/json

{
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "provider": "fcm",
  "providerCredentials": {
    "type": "string",
    "project_id": "string",
    "private_key_id": "string",
    "private_key": "<private_key>",
    "client_email": "string",
    "client_id": "string",
    "auth_uri": "string",
    "token_uri": "string",
    "auth_provider_x509_cert_url": "string",
    "client_x509_cert_url": "string",
    "universe_domain": "string"
  },
  "tenantId": 0,
  "dataAttributes": [
    {}
  ],
  "topics": [
    {}
  ]
}

Example · 26 linesShow full heightShow compact view

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

notFound

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Responses 500

Status200 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

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

Try it

Setup push notifications#

POST/api/v1/app-push/setup

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateFCMPushSetupRequestDto

3 top-level fieldsSelect an object to expand

providerCredentialsstringRequired
dataAttributesarray of PushDataAttributeSchemaRequired4 required when the containing object is present4 fields
dataAttributes

PATCH/api/v1/app-push/setup

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaUpdateFCMPushSetupRequestDto

3 top-level fieldsSelect an object to expand

providerCredentialsstringRequired
dataAttributesarray of PushDataAttributeSchemaRequired4 required when the containing object is present4 fields
dataAttributes

POST/api/v1/app-push/subscribe

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

DELETE/api/v1/app-push/subscribe

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

PUT/api/v1/app-push/linksubscriber

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleLinkSubscriberToMemberRequestDto

2 top-level fields

tokenstringRequired
providerstringRequired
Allowed values: "fcm"

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

PUT/api/v1/app-push/open

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleTrackOpenMessageRequestDto

1 top-level field

itemKeystringRequired

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

Schema ExampleTrackOpenMessageRequestDto

Trigger dispatch of new push notification#

POST/api/v1/app-push/pushcontent

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExamplePushContentRequestDto

4 top-level fields

titlestringRequired
bodystringRequired
topicstringOptional
topics

GET/api/v1/app-push/pushcampaign

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"

Save new push notification campaign draft#

POST/api/v1/app-push/pushcampaign

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreatePushCampaignDto

5 top-level fields

titlestringRequired
The title of the push notificationminLength: 1maxLength: 65
bodystringRequired
The body of the push notification:

GET/api/v1/app-push/pushcampaign/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExamplePushCampaignResponseDto

Same fields as Save new push notification campaign draft (201).

DELETE/api/v1/app-push/pushcampaign/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExamplePushCampaignResponseDto

Same fields as Save new push notification campaign draft (201).

PATCH/api/v1/app-push/pushcampaign/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExamplePushCampaignDraftUpdateDto

5 top-level fields

titlestringOptional
The title of the push notificationminLength: 1maxLength:

Send push campaign#

POST/api/v1/app-push/pushcampaign/{id}/send

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExamplePushCampaignResponseDto

Same fields as .

Schedule push campaign#

POST/api/v1/app-push/pushcampaign/{id}/schedule

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleSchedulePushCampaignDto

6 top-level fields

titlestringOptional
The title of the push notification:

Cancel push campaign#

POST/api/v1/app-push/pushcampaign/{id}/cancel

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExamplePushCampaignResponseDto

Same fields as .

GET/api/v1/app-push/pushcampaign/{id}/receivers

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Query parameters4

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

Send test push#

POST/api/v1/app-push/pushcampaign/{id}/test

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleSendTestPushResponse

GET/api/v1/app-push/pushcampaign/{id}/stats

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExamplePushStats

name

string

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExamplePushSetupResponseDto

Same fields as Get push notifications setup (200).

Schema ExamplePushSetupResponseDto

200 · application/json

{
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "provider": "fcm",
  "providerCredentials": {
    "type": "string",
    "project_id": "string",
    "private_key_id": "string",
    "private_key": "<private_key>",
    "client_email": "string",
    "client_id": "string",
    "auth_uri": "string",
    "token_uri": "string",
    "auth_provider_x509_cert_url": "string",
    "client_x509_cert_url": "string",
    "universe_domain": "string"
  },
  "tenantId": 0,
  "dataAttributes": [
    {}
  ],
  "topics": [
    {}
  ]
}

Example · 26 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/setup \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerCredentials": "<providerCredentials>",
  "dataAttributes": [
    {}
  ],
  "topics": [
    {}
  ]
}'

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExamplePushSetupResponseDto

Same fields as Get push notifications setup (200).

Schema ExamplePushSetupResponseDto

200 · application/json

{
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "provider": "fcm",
  "providerCredentials": {
    "type": "string",
    "project_id": "string",
    "private_key_id": "string",
    "private_key": "<private_key>",
    "client_email": "string",
    "client_id": "string",
    "auth_uri": "string",
    "token_uri": "string",
    "auth_provider_x509_cert_url": "string",
    "client_x509_cert_url": "string",
    "universe_domain": "string"
  },
  "tenantId": 0,
  "dataAttributes": [
    {}
  ],
  "topics": [
    {}
  ]
}

Example · 26 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full height

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/setup \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerCredentials": "<providerCredentials>",
  "dataAttributes": [
    {}
  ],
  "topics": [
    {}
  ]
}'

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Responses 401

unauthorized

Responses 403

Status201 401 403 500application/json

forbiddenResource

Responses 500

Status201 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/subscribe \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "<token>",
  "provider": "fcm",
  "topics": [
    "string"
  ]
}'

Responses

4 status codes

Responses 200

Responses 401

unauthorized

Responses 403

Status200 401 403 500application/json

forbiddenResource

Responses 500

Status200 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/subscribe \
  --request DELETE \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "<token>",
  "provider": "fcm"
}'

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

Status200 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/linksubscriber \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "<token>",
  "provider": "fcm"
}'

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/open \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "itemKey": "<itemKey>"
}'

array of string

Schema ExamplePushContentRequestDto

application/json

{
  "title": "string",
  "body": "string",
  "topic": "string",
  "topics": [
    "string"
  ]
}

Example · 8 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema ExamplePushContent

15 top-level fieldsSelect an object to expand

titlestringRequired
bodystringRequired
dataobjectRequired
tenantIdnumberRequired
segmentIdnumberRequired
statusstringRequired
Field details
Allowed values: "draft", "scheduled", "created", "queuing", "queued", "failed", "skipped", "dispatching", "dispatched"
scheduledAtstring (date-time)Required
topicsarray of stringRequired
tenantTenantRequired65 fields
tenant
- marketstringRequiredField path: tenant.market
  Operating market of the tenant (immutable post-install).Allowed values: "NO", "SE", "DK"
- productNamestringField path: tenant.productName
  The product name of the tenantAllowed values: "enterprise", "communication", "custom"
- additionalFeaturesarray of stringField path: tenant.additionalFeatures
  Field details
  The additional features of the tenantAllowed values: "email", "sms", "push", "podcasts", "subscription", "insights", "dashboard", "automation", "export", "accounting"
segmentSegmentRequiredNested fields omitted: field limit.
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

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

Schema ExamplePushContent

201 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 lines

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/pushcontent \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "string",
  "body": "string",
  "topic": "string",
  "topics": [
    "string"
  ]
}'

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExamplePushCampaignResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of PushCampaignResponseDtoRequired11 fields
items
- dataobjectRequired when parent is presentField path: items[].data
  The data to be sent with the push notification
- idnumberRequired when parent is presentField path: items[].id
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
- updatedAtstring (date-time)Required when parent is presentField path: items[].updatedAt
- titlestringRequired when parent is presentField path: items[].title
- bodystringRequired when parent is presentField path: items[].body
- tenantIdnumberRequired when parent is presentField path: items[].tenantId
- statusstringRequired when parent is presentField path: items[].status
  Field details
  Allowed values: "draft", "scheduled", "created", "queuing", "queued", "failed", "skipped", "dispatching", "dispatched"
- topicsarray of stringRequired when parent is presentField path: items[].topics
- segmentIdnumberRequired when parent is presentField path: items[].segmentId
- scheduledAtstring (date-time)Required when parent is presentField path: items[].scheduledAt
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExamplePushCampaignResponseDtoPaginated

200 · application/json

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

Example · 16 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 lines

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

minLength

1

Schema ExampleCreatePushCampaignDto

application/json

{
  "title": "This is the title of the push notification",
  "body": "This is the body of the push notification",
  "data": {
    "key": "value"
  },
  "topics": [
    "topic1",
    "topic2"
  ],
  "segmentId": 1
}

Example · 12 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema ExamplePushCampaignResponseDto

11 top-level fields

dataobjectRequired
The data to be sent with the push notification
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
titlestringRequired
bodystringRequired
tenantIdnumberRequired
statusstringRequired
Field details
Allowed values: "draft", "scheduled", "created", "queuing", "queued", "failed", "skipped", "dispatching", "dispatched"
topicsarray of stringRequired
segmentIdnumberRequired
scheduledAtstring (date-time)Required

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

Schema ExamplePushCampaignResponseDto

201 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 lines

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/app-push/pushcampaign \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "This is the title of the push notification",
  "body": "This is the body of the push notification",
  "data": {
    "key": "value"
  },
  "topics": [
    "topic1",
    "topic2"
  ],
  "segmentId": 1
}'

Schema ExamplePushCampaignResponseDto

200 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of 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 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExamplePushCampaignResponseDto

200 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

65

Schema ExamplePushCampaignDraftUpdateDto

application/json

{
  "title": "This is the title of the push notification",
  "body": "This is the body of the push notification",
  "data": {
    "key": "value"
  },
  "topics": [
    "topic1",
    "topic2"
  ],
  "segmentId": 1
}

Example · 12 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExamplePushCampaignResponseDto

Same fields as Save new push notification campaign draft (201).

Schema ExamplePushCampaignResponseDto

200 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/app-push/pushcampaign/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "This is the title of the push notification",
  "body": "This is the body of the push notification",
  "data": {
    "key": "value"
  },
  "topics": [
    "topic1",
    "topic2"
  ],
  "segmentId": 1
}'

Schema ExamplePushCampaignResponseDto

201 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

minLength

1

Schema ExampleSchedulePushCampaignDto

application/json

{
  "title": "This is the title of the push notification",
  "body": "This is the body of the push notification",
  "data": {
    "key": "value"
  },
  "topics": [
    "topic1",
    "topic2"
  ],
  "segmentId": 1,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 13 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExamplePushCampaignResponseDto

Same fields as Save new push notification campaign draft (201).

Schema ExamplePushCampaignResponseDto

201 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (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 push notifications setup (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/app-push/pushcampaign/{id}/schedule' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "This is the title of the push notification",
  "body": "This is the body of the push notification",
  "data": {
    "key": "value"
  },
  "topics": [
    "topic1",
    "topic2"
  ],
  "segmentId": 1,
  "scheduledAt": "2019-08-24T14:15:22Z"
}'

Schema ExamplePushCampaignResponseDto

201 · application/json

{
  "data": {
    "key": "value"
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "body": "string",
  "tenantId": 0,
  "status": "draft",
  "topics": [
    "string"
  ],
  "segmentId": 0,
  "scheduledAt": "2019-08-24T14:15:22Z"
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExamplePushSubscriberResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of PushSubscriberResponseDtoRequired12 fields
items
- idnumberRequired when parent is presentField path: items[].id
  The ID of the push subscriber
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
  The created at of the push subscriber
- updatedAtstring (date-time)Required when parent is presentField path: items[].updatedAt
  The updated at of the push subscriber
- metaDataobjectRequired when parent is presentField path: items[].metaData
  The meta data of the push subscriber
- providerstringRequired when parent is presentField path: items[].provider
  The provider of the push subscriberAllowed values: "fcm"
- memberIdstringRequired when parent is presentField path: items[].memberId
  The member id of the push subscriber
- topicsarray of stringRequired when parent is presentField path: items[].topics
  The topics of the push subscriber
- fullNamestringRequired when parent is presentField path: items[].fullName
  Can be nullThe first name of the member
- emailstringRequired when parent is presentField path: items[].email
  Can be nullThe email of the member
- statusstringRequired when parent is presentField path: items[].status
  Can be nullAllowed values: "queued", "dispatching", "dispatched", "failed"
- sentAtstring (date-time)Required when parent is presentField path: items[].sentAt
  Can be null
- openedAtstring (date-time)Required when parent is presentField path: items[].openedAt
  Can be null
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExamplePushSubscriberResponseDtoPaginated

200 · application/json

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

Example · 16 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get push notifications setup (403).

Responses 400

Status201 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get push campaign (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get push notifications setup (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

{
  "token": "<token>",
  "provider": "fcm",
  "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": {}
  },
  "tenantId": 0,
  "memberId": "string",
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "topics": [
    "string"
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

, "invoices"

, "ai"

{
  "title": "string",
  "body": "string",
  "data": {},
  "tenantId": 0,
  "segmentId": 0,
  "status": "draft",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "topics": [
    "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": {}
  },
  "segment": {
    "name": "string",
    "description": "string",
    "query": {
      "rules": []
    },
    "type": "static",
    "status": "draft",
    "adminUserId": 0,
    "adminUser": {
      "userRoles": [],
      "notes": [],
      "exportHistory": [],
      "userAccounts": [],
      "userSessions": [],
      "metaData": {}
    },
    "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": {}
    },
    "segmentMembers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Get push notifications setup#

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 500

Setup push notifications#

Request body

Update push notifications setup#

Request body

Subscribe to push notifications from app#

Request body

Unsubscribe from push notifications from app#

Request body

Link subscriber to member#

Request body

Track opening of message#

Request body

Trigger dispatch of new push notification#

Request body

Get all push campaigns#

Parameters

Save new push notification campaign draft#

Request body

Get push campaign#

Parameters

Responses

Responses 200

Delete push campaign#

Parameters

Responses

Responses 200

Update push campaign#

Parameters

Request body

Send push campaign#

Parameters

Responses

Responses 201

Schedule push campaign#

Parameters

Request body

Cancel push campaign#

Parameters

Responses

Responses 201

Get receivers for push campaign#

Parameters

Send test push#

Parameters

Responses

Responses 201

Get push campaign stats#

Parameters

Responses

Responses 200

Get push notifications setup#

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 500

Setup push notifications#

Request body

Update push notifications setup#

Request body

Subscribe to push notifications from app#

Request body

Unsubscribe from push notifications from app#

Request body

Link subscriber to member#

Request body

Track opening of message#

Request body

Trigger dispatch of new push notification#

Request body

Get all push campaigns#

Parameters