Transactional push

Send push notification to a specific subscriber

Send transaction message by subscriber id

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/transaction

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

omitCappingboolean

messageobject

tostring

Response

2004XX5XX

Body

application/json

messageIdstring

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/pushes/transaction', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "messageId": "text"
}

Send transaction message by subscriber id's

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/transaction/bulk

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

omitCappingboolean

messageobject

toarray of string

Response

2004XX5XX

Body

application/json

messageIdsarray of string

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/pushes/transaction/bulk', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "messageIds": [
    "text"
  ]
}

Send transaction message by external (custom id) subscriber id

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/transaction/external_id

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

omitCappingboolean

messageobject

externalIdstring

Response

2004XX5XX

Body

application/json

messageIdstring

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/pushes/transaction/external_id', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "messageId": "text"
}

Send transaction message by external (custom id) subscriber id's

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/transaction/external_id/bulk

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

omitCappingboolean

messageobject

externalIdsarray of string

Response

2004XX5XX

Body

application/json

messageIdsarray of string

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/pushes/transaction/external_id/bulk', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "messageIds": [
    "text"
  ]
}

Get all subscriberIds associated with externalId

GEThttps://api.pushpushgo.com/core/projects/{project}/external_ids/{externalId}

Authorization

ApiKeyAuth

Path parameters

project*string

externalId*string

Header parameters

Response

2004XX5XX

Body

application/json

externalIdstring

subscriberIdsarray of string

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/external_ids/{externalId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "externalId": "text",
  "subscriberIds": [
    "text"
  ]
}

Assign externalId to subscriberId

subscriberIds field returns always current state of given externalId

POSThttps://api.pushpushgo.com/core/projects/{project}/external_ids/assign

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

externalIdstring

subscriberIdstring

Response

2004XX5XX

Body

application/json

externalIdstring

subscriberIdsarray of string

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/external_ids/assign', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "externalId": "text",
  "subscriberIds": [
    "text"
  ]
}

Forgot all associated subscriberIds with given externalId

DELETEhttps://api.pushpushgo.com/core/projects/{project}/external_ids/forgot/{externalId}

Authorization

ApiKeyAuth

Path parameters

project*string

externalId*string

Header parameters

Response

2004XX5XX

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/external_ids/forgot/{externalId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false
}

unassign given subscriberId from current externalId

DELETEhttps://api.pushpushgo.com/core/projects/{project}/external_ids/unassign/{subscriberId}

Authorization

ApiKeyAuth

Path parameters

project*string

subscriberId*string

Header parameters

Response

2004XX5XX

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/external_ids/unassign/{subscriberId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false
}