Matched campaign

Send multiple notification variants matched to your subscribers labels in one campaign

Create and send matched campaign

Create and send matched campaign with variants containing unique message & targeting each. Set of labels used in variants cannot be the same & cannot be subset of another labels set.

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

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

sendDatestring

expireDatestring

omitCappingboolean

variantsarray of object

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Create matched campaign draft

Create matched campaign draft

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

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

any

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Delete matched campaign

Delete matched campaign draft or sent matched campaign.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/delete

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

any

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Add variants to matched campaign draft

Add variants of campaign which consist of unique message & targeting to matched campaign draft. Set of labels used in variants cannot be the same.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/add-variants

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

variantsarray of object

Response

2004XX5XX

Body

application/json

matchedCampaignVariantIdsarray of string

Request

JavaScriptCurl

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

Response

{
  "matchedCampaignVariantIds": [
    "text"
  ]
}

Delete variants from matched campaign draft

Delete unwanted variants from matched campaign draft.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/delete-variants

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

variantIdsarray of string

Response

2004XX5XX

Body

application/json

idstring

projectstring

sendDatestring

expireDatestring

createdAtstring

updatedAtstring

omitCappingboolean

variantIdsarray of string

stateenum

draftacceptedsendingsentfailedcanceleddeleted

imagesAddedboolean

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "project": "text",
  "sendDate": "text",
  "expireDate": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "omitCapping": false,
  "variantIds": [
    "text"
  ],
  "state": "draft",
  "imagesAdded": false
}

Accept matched campaign draft

Accept matched campaign draft.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/accept

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

omitCappingboolean

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Send matched campaign

Send matched campaign.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/send

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

sendDatestring

expireDatestring

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Cancel matched campaign

Cancel accepted/sending matched campaign.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/cancel

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

any

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Get matched campaign

Get info about matched campaign.

GEThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Response

2004XX5XX

Body

application/json

idstring

projectstring

sendDatestring

expireDatestring

createdAtstring

updatedAtstring

omitCappingboolean

variantIdsarray of string

stateenum

draftacceptedsendingsentfailedcanceleddeleted

imagesAddedboolean

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "project": "text",
  "sendDate": "text",
  "expireDate": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "omitCapping": false,
  "variantIds": [
    "text"
  ],
  "state": "draft",
  "imagesAdded": false
}

Get matched campaign variant

Get info about matched campaign variant.

GEThttps://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/variants/{variantId}

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

variantId*string

Header parameters

Response

2004XX5XX

Body

application/json

idstring

metadataobject

matchobject

Request

JavaScriptCurl

const response = await fetch('https://api.pushpushgo.com/core/projects/{project}/pushes/matched/{campaign}/variants/{variantId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "metadata": {
    "title": "text",
    "content": "text",
    "redirectLink": "text",
    "requireInteraction": false,
    "actions": [
      {
        "title": "text",
        "link": "text"
      }
    ],
    "icon": "text",
    "image": "text",
    "direction": "text"
  },
  "match": {
    "labels": [
      "text"
    ]
  }
}