Skip to main content
PUT
/
prod
/
rss-notification
/
{id}
Update RSS Campaign
curl --request PUT \
  --url https://api.aimtell.com/prod/rss-notification/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization-Api-Key: <api-key>' \
  --data '
{
  "status": 123,
  "name": "<string>",
  "feed_url": "<string>",
  "title": "<string>",
  "body": "<string>",
  "link": "<string>",
  "customIcon": "<string>",
  "customImage": "<string>",
  "segments": "<string>",
  "max_enabled": 123,
  "max_type": "<string>",
  "max_value": 123,
  "actions": {
    "a01": {
      "title": "<string>",
      "link": "<string>"
    },
    "a02": {
      "title": "<string>",
      "link": "<string>"
    }
  },
  "collapse_key": "<string>"
}
'
{
  "result": "success",
  "campaignId": "128"
}

Authorizations

X-Authorization-Api-Key
string
header
default:""
required

Path Parameters

id
string
required

Campaign ID

Body

application/json
status
integer<int32>
required

set 1 for draft, 2 for active

name
string

Name of Campaign

feed_url
string

URL of RSS feed

title
string

Push Title

body
string

Push Body Message

Push Notification Link

customIcon
string

url of custom icon to use (recommended size: 250x250)

customImage
string

url of custom image to use (recommended size: 300x500))

segments
string

Segments — comma separated list with no spaces e.g. 12345,12346,12347

max_enabled
integer<int32>

enable maximum number of sends — set 0 for false, 1 for true

max_type
string

hourly or daily

max_value
integer<int32>

maximum number of sends e.g. 5 or 20

actions
object
collapse_key
string

replace visible notifications on a subscribers device (e.g. breaking_news)

Response

200