Segmented campaign

Send push campaign to a segment

Create and send segmented campaign

Campaign will be sent to all subscribers as soon as possible

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

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

messageobject

optionsobject

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Create draft segmented campaign

After created - campaign must be accept by /accept endpoint to send

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

Authorization

ApiKeyAuth

Path parameters

project*string

Header parameters

Body

application/json

messageobject

optionsobject

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Get details of segmented campaign

Returns all details of campaign

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

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Response

2004XX5XX

Body

application/json

idstring

campaignTypeenum

rocketmasssegmentationtemporary_labelsgeolocation

stateenum

readydeleteddraftsendinginqueuestoppedsentfailedblocked

messageobject

optionsobject

projectstring

metadataobject

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "campaignType": "rocket",
  "state": "ready",
  "message": {
    "actions": [
      {
        "link": "text",
        "title": "text"
      }
    ],
    "content": "text",
    "delayTime": 0,
    "direction": "text",
    "expireDate": "text",
    "icon": "text",
    "image": "text",
    "redirectLink": "text",
    "sendDate": "text",
    "title": "text"
  },
  "options": {
    "omitCapping": false,
    "requireInteraction": false,
    "segment": {
      "audience": 0,
      "exists": false,
      "id": "text",
      "name": "text"
    }
  },
  "project": "text",
  "metadata": {
    "fromAPI": false,
    "sentBy": "text"
  }
}

Update draft or ready segmented campaign

Action is available only on draft or ready state

PUThttps://api.pushpushgo.com/core/projects/{project}/pushes/segmented/{campaign}

Authorization

ApiKeyAuth

Path parameters

project*string

campaign*string

Header parameters

Body

application/json

messageobject

optionsobject

Response

2004XX5XX

Body

application/json

idstring

Request

JavaScriptCurl

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

Response

{
  "id": "text"
}

Accept segmented campaign to send

Accept campaign - send campaign to sender - available only on draft state

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

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/segmented/{campaign}/accept', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "id": "text"
}

Cancel sending of segmented campaign

This is available only on "ready / sending" state, also this action cancel process of "sending" if campaign is actually on sender, in ready state just change state to cancel to prevent send them to sender.

POSThttps://api.pushpushgo.com/core/projects/{project}/pushes/segmented/{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/segmented/{campaign}/cancel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "id": "text"
}