Create notification campaign

curl --request POST \
  --url https://{host}/push/v2/Campaign/notifications/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "startAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "issuer": "<string>"
  },
  "push": {
    "title": "<string>",
    "message": "<string>",
    "templateName": "<string>",
    "expirationDate": "2023-11-07T05:31:56Z",
    "deepLinkId": "<string>",
    "deepLinkParameters": "<string>",
    "deepLinkUrl": "<string>",
    "unifiedCampaignId": "<string>"
  },
  "customerIds": [
    "<string>"
  ],
  "operationId": "<string>"
}
'

import requests

url = "https://{host}/push/v2/Campaign/notifications/send"

payload = {
    "campaign": {
        "id": "<string>",
        "name": "<string>",
        "startAt": "2023-11-07T05:31:56Z",
        "endAt": "2023-11-07T05:31:56Z",
        "issuer": "<string>"
    },
    "push": {
        "title": "<string>",
        "message": "<string>",
        "templateName": "<string>",
        "expirationDate": "2023-11-07T05:31:56Z",
        "deepLinkId": "<string>",
        "deepLinkParameters": "<string>",
        "deepLinkUrl": "<string>",
        "unifiedCampaignId": "<string>"
    },
    "customerIds": ["<string>"],
    "operationId": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    campaign: {
      id: '<string>',
      name: '<string>',
      startAt: '2023-11-07T05:31:56Z',
      endAt: '2023-11-07T05:31:56Z',
      issuer: '<string>'
    },
    push: {
      title: '<string>',
      message: '<string>',
      templateName: '<string>',
      expirationDate: '2023-11-07T05:31:56Z',
      deepLinkId: '<string>',
      deepLinkParameters: '<string>',
      deepLinkUrl: '<string>',
      unifiedCampaignId: '<string>'
    },
    customerIds: ['<string>'],
    operationId: '<string>'
  })
};

fetch('https://{host}/push/v2/Campaign/notifications/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/push/v2/Campaign/notifications/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign' => [
        'id' => '<string>',
        'name' => '<string>',
        'startAt' => '2023-11-07T05:31:56Z',
        'endAt' => '2023-11-07T05:31:56Z',
        'issuer' => '<string>'
    ],
    'push' => [
        'title' => '<string>',
        'message' => '<string>',
        'templateName' => '<string>',
        'expirationDate' => '2023-11-07T05:31:56Z',
        'deepLinkId' => '<string>',
        'deepLinkParameters' => '<string>',
        'deepLinkUrl' => '<string>',
        'unifiedCampaignId' => '<string>'
    ],
    'customerIds' => [
        '<string>'
    ],
    'operationId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/push/v2/Campaign/notifications/send"

	payload := strings.NewReader("{\n  \"campaign\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"startAt\": \"2023-11-07T05:31:56Z\",\n    \"endAt\": \"2023-11-07T05:31:56Z\",\n    \"issuer\": \"<string>\"\n  },\n  \"push\": {\n    \"title\": \"<string>\",\n    \"message\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"expirationDate\": \"2023-11-07T05:31:56Z\",\n    \"deepLinkId\": \"<string>\",\n    \"deepLinkParameters\": \"<string>\",\n    \"deepLinkUrl\": \"<string>\",\n    \"unifiedCampaignId\": \"<string>\"\n  },\n  \"customerIds\": [\n    \"<string>\"\n  ],\n  \"operationId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/push/v2/Campaign/notifications/send")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"campaign\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"startAt\": \"2023-11-07T05:31:56Z\",\n    \"endAt\": \"2023-11-07T05:31:56Z\",\n    \"issuer\": \"<string>\"\n  },\n  \"push\": {\n    \"title\": \"<string>\",\n    \"message\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"expirationDate\": \"2023-11-07T05:31:56Z\",\n    \"deepLinkId\": \"<string>\",\n    \"deepLinkParameters\": \"<string>\",\n    \"deepLinkUrl\": \"<string>\",\n    \"unifiedCampaignId\": \"<string>\"\n  },\n  \"customerIds\": [\n    \"<string>\"\n  ],\n  \"operationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/push/v2/Campaign/notifications/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"campaign\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"startAt\": \"2023-11-07T05:31:56Z\",\n    \"endAt\": \"2023-11-07T05:31:56Z\",\n    \"issuer\": \"<string>\"\n  },\n  \"push\": {\n    \"title\": \"<string>\",\n    \"message\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"expirationDate\": \"2023-11-07T05:31:56Z\",\n    \"deepLinkId\": \"<string>\",\n    \"deepLinkParameters\": \"<string>\",\n    \"deepLinkUrl\": \"<string>\",\n    \"unifiedCampaignId\": \"<string>\"\n  },\n  \"customerIds\": [\n    \"<string>\"\n  ],\n  \"operationId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

POST

Campaign

notifications

send

Create notification campaign

curl --request POST \
  --url https://{host}/push/v2/Campaign/notifications/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "startAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "issuer": "<string>"
  },
  "push": {
    "title": "<string>",
    "message": "<string>",
    "templateName": "<string>",
    "expirationDate": "2023-11-07T05:31:56Z",
    "deepLinkId": "<string>",
    "deepLinkParameters": "<string>",
    "deepLinkUrl": "<string>",
    "unifiedCampaignId": "<string>"
  },
  "customerIds": [
    "<string>"
  ],
  "operationId": "<string>"
}
'

import requests

url = "https://{host}/push/v2/Campaign/notifications/send"

payload = {
    "campaign": {
        "id": "<string>",
        "name": "<string>",
        "startAt": "2023-11-07T05:31:56Z",
        "endAt": "2023-11-07T05:31:56Z",
        "issuer": "<string>"
    },
    "push": {
        "title": "<string>",
        "message": "<string>",
        "templateName": "<string>",
        "expirationDate": "2023-11-07T05:31:56Z",
        "deepLinkId": "<string>",
        "deepLinkParameters": "<string>",
        "deepLinkUrl": "<string>",
        "unifiedCampaignId": "<string>"
    },
    "customerIds": ["<string>"],
    "operationId": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    campaign: {
      id: '<string>',
      name: '<string>',
      startAt: '2023-11-07T05:31:56Z',
      endAt: '2023-11-07T05:31:56Z',
      issuer: '<string>'
    },
    push: {
      title: '<string>',
      message: '<string>',
      templateName: '<string>',
      expirationDate: '2023-11-07T05:31:56Z',
      deepLinkId: '<string>',
      deepLinkParameters: '<string>',
      deepLinkUrl: '<string>',
      unifiedCampaignId: '<string>'
    },
    customerIds: ['<string>'],
    operationId: '<string>'
  })
};

fetch('https://{host}/push/v2/Campaign/notifications/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/push/v2/Campaign/notifications/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign' => [
        'id' => '<string>',
        'name' => '<string>',
        'startAt' => '2023-11-07T05:31:56Z',
        'endAt' => '2023-11-07T05:31:56Z',
        'issuer' => '<string>'
    ],
    'push' => [
        'title' => '<string>',
        'message' => '<string>',
        'templateName' => '<string>',
        'expirationDate' => '2023-11-07T05:31:56Z',
        'deepLinkId' => '<string>',
        'deepLinkParameters' => '<string>',
        'deepLinkUrl' => '<string>',
        'unifiedCampaignId' => '<string>'
    ],
    'customerIds' => [
        '<string>'
    ],
    'operationId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/push/v2/Campaign/notifications/send"

	payload := strings.NewReader("{\n  \"campaign\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"startAt\": \"2023-11-07T05:31:56Z\",\n    \"endAt\": \"2023-11-07T05:31:56Z\",\n    \"issuer\": \"<string>\"\n  },\n  \"push\": {\n    \"title\": \"<string>\",\n    \"message\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"expirationDate\": \"2023-11-07T05:31:56Z\",\n    \"deepLinkId\": \"<string>\",\n    \"deepLinkParameters\": \"<string>\",\n    \"deepLinkUrl\": \"<string>\",\n    \"unifiedCampaignId\": \"<string>\"\n  },\n  \"customerIds\": [\n    \"<string>\"\n  ],\n  \"operationId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/push/v2/Campaign/notifications/send")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"campaign\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"startAt\": \"2023-11-07T05:31:56Z\",\n    \"endAt\": \"2023-11-07T05:31:56Z\",\n    \"issuer\": \"<string>\"\n  },\n  \"push\": {\n    \"title\": \"<string>\",\n    \"message\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"expirationDate\": \"2023-11-07T05:31:56Z\",\n    \"deepLinkId\": \"<string>\",\n    \"deepLinkParameters\": \"<string>\",\n    \"deepLinkUrl\": \"<string>\",\n    \"unifiedCampaignId\": \"<string>\"\n  },\n  \"customerIds\": [\n    \"<string>\"\n  ],\n  \"operationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/push/v2/Campaign/notifications/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"campaign\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"startAt\": \"2023-11-07T05:31:56Z\",\n    \"endAt\": \"2023-11-07T05:31:56Z\",\n    \"issuer\": \"<string>\"\n  },\n  \"push\": {\n    \"title\": \"<string>\",\n    \"message\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"expirationDate\": \"2023-11-07T05:31:56Z\",\n    \"deepLinkId\": \"<string>\",\n    \"deepLinkParameters\": \"<string>\",\n    \"deepLinkUrl\": \"<string>\",\n    \"unifiedCampaignId\": \"<string>\"\n  },\n  \"customerIds\": [\n    \"<string>\"\n  ],\n  \"operationId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

campaign

object

required

Show child attributes

push

object

required

Show child attributes

customerIds

string[]

required

operationId

string

required

Required string length: 1 - 125

Response

Success

integer<int64>

Last modified on August 10, 2026

⌘I