Create Push Campaign

POST

campaigns

curl --request POST \
  --url https://api.castled.io/backend/external/v1/campaigns \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "my-campaign",
  "externalId": "<string>",
  "segment": {
    "query": "select * from users",
    "primaryKey": "user_id"
  },
  "schedule": {
    "type": "START_NOW",
    "startTs": 123
  },
  "message": {
    "type": "MOBILE_PUSH",
    "iosEnabled": true,
    "androidEnabled": true,
    "title": {
      "en": "Hey {{ first_name | '\''there'\'' }}",
      "hi": " हेलो {{ first_name | '\''there'\'' }}"
    },
    "subtitle": {},
    "body": {
      "en": "Hello from Castled!",
      "hi": "कैसल्ड की ओर से नमस्ते!"
    },
    "collapseId": "<string>",
    "ttl": 123,
    "action": "DEFAULT",
    "androidActionUrl": "<string>",
    "iosActionUrl": "<string>",
    "keyVals": {},
    "bigImageUrl": "<string>",
    "largeIconUrl": "<string>",
    "smallIconResourceId": "<string>",
    "androidChannel": "<string>",
    "priority": "NORMAL",
    "androidActionButtons": [
      {
        "label": "<string>",
        "url": "<string>",
        "clickAction": "DEEP_LINKING",
        "keyVals": {}
      }
    ],
    "soundFileName": "<string>",
    "richMediaUrl": "<string>",
    "mediaType": "IMAGE",
    "interruptionLevel": "PASSIVE",
    "badgeCount": 123,
    "relevanceScore": "SCORE_MAX",
    "contentAvailable": true,
    "actionCategory": {
      "type": "PREDEFINED_CATEGORY",
      "name": "<string>",
      "actionComponents": [
        {
          "actionId": "<string>",
          "url": "<string>",
          "clickAction": "DEEP_LINKING",
          "keyVals": {},
          "useWebview": true
        }
      ]
    }
  }
}'

{
  "uuid": "<string>"
}

Headers

Api-Key

string

required

Private key to access the API.

Body

application/json

Event data to be tracked.

Schema representing campaign create request data.

name

string

required

Name of the campaign

segment

object

required

Segment of users for whom campaign is being run

schedule

object

required

Campaign start schedule

message

object

required

Campaign message details.

message.type

enum<string>

required

Campaign type

Available options:

MOBILE_PUSH

message.iosEnabled

boolean

required

Should send notification to iOS device

message.androidEnabled

boolean

required

Should send notification to Android device

message.title

object

required

Map of ISO 639 language code to corresponding title text in that language. Text supports personalization.

message.body

object

required

Map of ISO 639 language code to corresponding body text in that language. Text supports personalization.

message.subtitle

object

Map of ISO 639 language code to corresponding subtitle text in that language

message.collapseId

string

A newer message with same collapseId will replace the older message if it is yet to be delivered to the device

message.ttl

number

Time-to-live specifies how long the server cache the message for retry before it could be delivered to the mobile device

message.action

enum<string>

Defines the action when notification is tapped

Available options:

DEFAULT,

DEEP_LINKING,

RICH_LANDING

message.androidActionUrl

string

Url associated with the action for Android device

message.iosActionUrl

string

Url associated with the action for iOS device

message.keyVals

object

A flatmap for passing any additional arguments to the tap action

message.bigImageUrl

string

Url of the image to be displayed. Android only

message.largeIconUrl

string

Url of the large icon. Android only

message.smallIconResourceId

string

Resource id of the small icon. Android only

message.androidChannel

string

Channel on which the notification is sent. Android only

message.priority

enum<string>

Normal priority messages are delivered immediately when the device is not sleeping. FCM attempts to deliver high priority messages immediately, allowing FCM to wake a sleeping device when necessary. Android only

Available options:

NORMAL,

HIGH

message.androidActionButtons

object[]

Array of notification action buttons

message.soundFileName

string

custom sound for your notification. iOS only

message.richMediaUrl

string

Rich media url. iOS only

message.mediaType

enum<string>

Rich media type. iOS only

Available options:

IMAGE,

AUDIO,

VIDEO

message.interruptionLevel

enum<string>

Defines the priority and presentation style of the notification based on the content's urgency and relevance. iOS only

Available options:

PASSIVE,

ACTIVE,

TIME_SENSITIVE,

CRITICAL

message.badgeCount

number

Increment notification badge by this number. iOS only

message.relevanceScore

enum<string>

A relevance score is a float value between 0 and 1 that developers can assign to each notification to indicate its importance relative to other notifications from the same app. The iOS system uses this score to determine the ordering of notifications within the Notification Summary. iOS only

Available options:

SCORE_MAX,

SCORE_0_75,

SCORE_0_50,

SCORE_0_25,

SCORE_MIN

message.contentAvailable

boolean

Setting contentAvailable to true in a push notification payload indicates that the notification should be delivered to the device immediately, even if the app is in the background or not running. This allows the app to wake up in the background and perform tasks such as fetching new content or updating data without necessarily displaying a visible notification to the user. iOS only

message.actionCategory

object

Notification long tap actions. iOS only

externalId

string

Optional external id assigned to the campaign. Used to ensure idempotency, to prevent same campaign from being created more than once. Max length of 256 chars

Response

200 - application/json

Campaign successfully created

A standard response for successful campaign creation.

uuid

string

UUID of the created campaign

Track event Get Campaign Status

curl --request POST \
  --url https://api.castled.io/backend/external/v1/campaigns \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "my-campaign",
  "externalId": "<string>",
  "segment": {
    "query": "select * from users",
    "primaryKey": "user_id"
  },
  "schedule": {
    "type": "START_NOW",
    "startTs": 123
  },
  "message": {
    "type": "MOBILE_PUSH",
    "iosEnabled": true,
    "androidEnabled": true,
    "title": {
      "en": "Hey {{ first_name | '\''there'\'' }}",
      "hi": " हेलो {{ first_name | '\''there'\'' }}"
    },
    "subtitle": {},
    "body": {
      "en": "Hello from Castled!",
      "hi": "कैसल्ड की ओर से नमस्ते!"
    },
    "collapseId": "<string>",
    "ttl": 123,
    "action": "DEFAULT",
    "androidActionUrl": "<string>",
    "iosActionUrl": "<string>",
    "keyVals": {},
    "bigImageUrl": "<string>",
    "largeIconUrl": "<string>",
    "smallIconResourceId": "<string>",
    "androidChannel": "<string>",
    "priority": "NORMAL",
    "androidActionButtons": [
      {
        "label": "<string>",
        "url": "<string>",
        "clickAction": "DEEP_LINKING",
        "keyVals": {}
      }
    ],
    "soundFileName": "<string>",
    "richMediaUrl": "<string>",
    "mediaType": "IMAGE",
    "interruptionLevel": "PASSIVE",
    "badgeCount": 123,
    "relevanceScore": "SCORE_MAX",
    "contentAvailable": true,
    "actionCategory": {
      "type": "PREDEFINED_CATEGORY",
      "name": "<string>",
      "actionComponents": [
        {
          "actionId": "<string>",
          "url": "<string>",
          "clickAction": "DEEP_LINKING",
          "keyVals": {},
          "useWebview": true
        }
      ]
    }
  }
}'

{
  "uuid": "<string>"
}

Product Events

Campaigns

Push Notification

Create Push Campaign

Headers

Body

Response