Update a push campaign draft
curl --request PATCH \
--url https://api.sendrealm.com/push/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"messages": [
{
"code": "<string>",
"title": "<string>",
"body": "<string>",
"label": "<string>",
"image_url": "<string>",
"launch_url": "<string>"
}
],
"audience": {
"include_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"platforms": {
"android": true,
"ios": true,
"web": true
},
"buttons": [
{
"id": "<string>",
"text": "<string>",
"title": "<string>",
"icon": "<string>",
"launch_url": "<string>"
}
],
"template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"android_config": {},
"live_activity_config": {}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
messages: [
{
code: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
label: '<string>',
image_url: '<string>',
launch_url: '<string>'
}
],
audience: {
include_audience_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
exclude_audience_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
platforms: {android: true, ios: true, web: true},
buttons: [
{
id: '<string>',
text: '<string>',
title: '<string>',
icon: '<string>',
launch_url: '<string>'
}
],
template_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
android_config: {},
live_activity_config: {}
})
};
fetch('https://api.sendrealm.com/push/campaigns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sendrealm.com/push/campaigns/{id}"
payload = {
"name": "<string>",
"messages": [
{
"code": "<string>",
"title": "<string>",
"body": "<string>",
"label": "<string>",
"image_url": "<string>",
"launch_url": "<string>"
}
],
"audience": {
"include_audience_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"exclude_audience_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"platforms": {
"android": True,
"ios": True,
"web": True
},
"buttons": [
{
"id": "<string>",
"text": "<string>",
"title": "<string>",
"icon": "<string>",
"launch_url": "<string>"
}
],
"template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"android_config": {},
"live_activity_config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"status": 123,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"app_id": "<string>",
"app_name": "<string>",
"name": "<string>",
"status": "<string>",
"channel": "push",
"targeting": {},
"mode": "<string>",
"environment": "<string>",
"messages": [
{
"code": "<string>",
"label": "<string>",
"title": "<string>",
"body": "<string>",
"image_url": "<string>",
"launch_url": "<string>"
}
],
"buttons": [
{
"id": "<string>",
"text": "<string>",
"title": "<string>",
"icon": "<string>",
"launch_url": "<string>"
}
],
"platforms": {
"android": true,
"ios": true,
"web": true
},
"audience": {
"type": "<string>",
"include_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"android_config": {},
"live_activity_config": {},
"is_editable": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"status": 123,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<string>",
"issues": [
{
"code": "<string>",
"path": "<string>",
"message": "<string>"
}
]
}
}{
"status": 123,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<string>",
"issues": [
{
"code": "<string>",
"path": "<string>",
"message": "<string>"
}
]
}
}{
"status": 123,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<string>",
"issues": [
{
"code": "<string>",
"path": "<string>",
"message": "<string>"
}
]
}
}Push Notifications
Update Push Campaign
Update content, platforms, audiences, template selection, and platform configuration. Scheduling and launch are not accepted.
PATCH
/
push
/
campaigns
/
{id}
Update a push campaign draft
curl --request PATCH \
--url https://api.sendrealm.com/push/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"messages": [
{
"code": "<string>",
"title": "<string>",
"body": "<string>",
"label": "<string>",
"image_url": "<string>",
"launch_url": "<string>"
}
],
"audience": {
"include_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"platforms": {
"android": true,
"ios": true,
"web": true
},
"buttons": [
{
"id": "<string>",
"text": "<string>",
"title": "<string>",
"icon": "<string>",
"launch_url": "<string>"
}
],
"template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"android_config": {},
"live_activity_config": {}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
messages: [
{
code: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
label: '<string>',
image_url: '<string>',
launch_url: '<string>'
}
],
audience: {
include_audience_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
exclude_audience_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
platforms: {android: true, ios: true, web: true},
buttons: [
{
id: '<string>',
text: '<string>',
title: '<string>',
icon: '<string>',
launch_url: '<string>'
}
],
template_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
android_config: {},
live_activity_config: {}
})
};
fetch('https://api.sendrealm.com/push/campaigns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sendrealm.com/push/campaigns/{id}"
payload = {
"name": "<string>",
"messages": [
{
"code": "<string>",
"title": "<string>",
"body": "<string>",
"label": "<string>",
"image_url": "<string>",
"launch_url": "<string>"
}
],
"audience": {
"include_audience_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"exclude_audience_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"platforms": {
"android": True,
"ios": True,
"web": True
},
"buttons": [
{
"id": "<string>",
"text": "<string>",
"title": "<string>",
"icon": "<string>",
"launch_url": "<string>"
}
],
"template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"android_config": {},
"live_activity_config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"status": 123,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"app_id": "<string>",
"app_name": "<string>",
"name": "<string>",
"status": "<string>",
"channel": "push",
"targeting": {},
"mode": "<string>",
"environment": "<string>",
"messages": [
{
"code": "<string>",
"label": "<string>",
"title": "<string>",
"body": "<string>",
"image_url": "<string>",
"launch_url": "<string>"
}
],
"buttons": [
{
"id": "<string>",
"text": "<string>",
"title": "<string>",
"icon": "<string>",
"launch_url": "<string>"
}
],
"platforms": {
"android": true,
"ios": true,
"web": true
},
"audience": {
"type": "<string>",
"include_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude_audience_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"android_config": {},
"live_activity_config": {},
"is_editable": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"status": 123,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<string>",
"issues": [
{
"code": "<string>",
"path": "<string>",
"message": "<string>"
}
]
}
}{
"status": 123,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<string>",
"issues": [
{
"code": "<string>",
"path": "<string>",
"message": "<string>"
}
]
}
}{
"status": 123,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<string>",
"issues": [
{
"code": "<string>",
"path": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Maximum string length:
120Available options:
production, development Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
standard, live_activity Maximum array length:
3- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I