Skip to main content
PUT
/
prod
/
event-campaign
/
{id}
Update Event Triggered Campaign
curl --request PUT \
  --url https://api.aimtell.com/prod/event-campaign/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "body": "<string>",
  "link": "<string>",
  "status": 123,
  "eventAction": "<string>",
  "eventCategory": "<string>",
  "eventLabel": "<string>",
  "delay": 123,
  "drip": "<string>",
  "customIcon": "<string>",
  "customImage": "<string>",
  "target_device": "<string>",
  "actions": {
    "a01": {
      "title": "<string>",
      "link": "<string>"
    },
    "a02": {
      "title": "<string>",
      "link": "<string>"
    }
  },
  "collapse_key": "<string>"
}
'
{
  "result": "success",
  "campaignId": "329"
}

Documentation Index

Fetch the complete documentation index at: https://developers.aimtell.com/llms.txt

Use this file to discover all available pages before exploring further.

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 Message

Push Notification Link

status
integer

set 1 for draft, 5 for active

eventAction
string
eventCategory
string
eventLabel
string
delay
integer

Time in seconds after event when push should be sent

drip
string

Comma separated integer values representing delays as seconds from event. Example: 60, 300, 3600

customIcon
string

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

customImage
string

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

target_device
string

device type to target (optional). can be either: "any", "mobile" or "desktop"

actions
object

action buttons

collapse_key
string

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

Response

200