Skip to main content
PUT
/
prod
/
campaign
/
{id}
Update Campaign
curl --request PUT \
  --url https://api.aimtell.com/prod/campaign/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "body": "<string>",
  "link": "<string>",
  "schedule_date": "2023-12-25",
  "segments": "<string>",
  "automation": "<string>",
  "automation_end": "2023-12-25",
  "push_ttl": 123,
  "auto_hide": 123,
  "collapse_key": "<string>",
  "tz_delivery": 123,
  "customIcon": "<string>",
  "customImage": "<string>",
  "status": 1,
  "version_b": {
    "status": 123,
    "title": "<string>",
    "body": "<string>",
    "link": "<string>",
    "customIcon": "<string>",
    "customImage": "<string>",
    "actions": {
      "a01": {
        "title": "<string>",
        "link": "<string>"
      },
      "a02": {
        "title": "<string>",
        "link": "<string>"
      }
    }
  },
  "conversion_trigger": {
    "eventCategory": "<string>",
    "eventAction": "<string>"
  },
  "actions": {
    "a01": {
      "title": "<string>",
      "link": "<string>"
    },
    "a02": {
      "title": "<string>",
      "link": "<string>"
    }
  }
}
'
{
  "result": "success",
  "campaignId": "133321"
}

Authorizations

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

Path Parameters

id
string
required

Campaign ID

Body

application/json
name
string

Name of Campaign

title
string

Push Title

body
string

Push Body

Push Link

schedule_date
string<date>

DateTime (i.e. 2017-08-25 21:16:50)

segments
string

Segments

automation
string

Automation (d = daily, w = weekly, m = monthly, n = none)

automation_end
string<date>

Automation End Date (e.g. 2017-08-25 17:00:00)

push_ttl
integer<int32>

Expiration Time (in seconds)

auto_hide
integer<int32>

Auto Hide (in seconds)

collapse_key
string

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

tz_delivery
integer<int32>

deliver based on user's timezone (set 0 for false, 1 for true)

customIcon
string

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

customImage
string

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

status
integer<int32>
default:1

set 1 for draft, 2 for scheduled

version_b
object

(optional) Version B for A/B test campaign

conversion_trigger
object
actions
object

action buttons

Response

200