Campaign Automation

Beta

Campaign Automation

+ Day(s) remaining in the trial

Overview

Campaign Automation API for use with mobile push, and email messaging features.

Getting started

Developer Center

Please see a list of Getting Started, Tutorials, SDKs, Blogs, Forum, and Documentation in the Campaign Automation DevCenter here: https://developer.ibm.com/centers/mobile-app-messaging/

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

Campaign Automation:

channels

Create Rich Content

POST   /channels/push/richcontent

			https://api4.silverpop.com/rest/channels/push/richcontent
		
Keys
Request code
Request model

personalizationDefaults

ARRAY , optional

items

STRING , optional

personalizationFormulas

ARRAY , optional

items

STRING , optional

payload

object , optional

apns

object , optional

template

STRING , optional

Template name

content

object , optional

messagePreview

object , optional

subject

STRING , optional

Subject of the message with optional personalization tags

previewContent

STRING , optional

Content of the preview with optional personalization tags

messageDetails

object , optional

richContent

STRING , optional

Content for rich push

TemplateContent

OBJECT , optional

TemplateContent

OBJECT , optional

Request example
{
  "personalizationDefaults": [{
    "items": string
  }],
  "personalizationFormulas": [{
    "items": string
  }],
  "payload": {
    "apns": {
    "template": string,
    "content": {
    "messagePreview": {
    "subject": string,
    "previewContent": string
  },
    "messageDetails": {
    "richContent": string
  }
  }
  },
    "TemplateContent": object,
    "TemplateContent": object
  }
}
Response model

200

OK

Body

richContentId

STRING , optional

400

Bad Request

Body

Response example

200

OK

								{
  "richContentId" : string
}
							

400

Bad Request

								
							
Create Rich Content

POST   /channels/push/richcontent

			https://api4.silverpop.com/rest/channels/push/richcontent
		
Keys
Request code
Request model

personalizationDefaults

ARRAY , optional

items

STRING , optional

personalizationFormulas

ARRAY , optional

items

STRING , optional

payload

object , optional

apns

object , optional

template

STRING , optional

Template name

content

object , optional

messagePreview

object , optional

subject

STRING , optional

Subject of the message with optional personalization tags

previewContent

STRING , optional

Content of the preview with optional personalization tags

messageDetails

object , optional

richContent

STRING , optional

Content for rich push

TemplateContent

OBJECT , optional

TemplateContent

OBJECT , optional

Request example
{
  "personalizationDefaults": [{
    "items": string
  }],
  "personalizationFormulas": [{
    "items": string
  }],
  "payload": {
    "apns": {
    "template": string,
    "content": {
    "messagePreview": {
    "subject": string,
    "previewContent": string
  },
    "messageDetails": {
    "richContent": string
  }
  }
  },
    "TemplateContent": object,
    "TemplateContent": object
  }
}
Response model

200

OK

Body

richContentId

STRING , optional

400

Bad Request

Body

Response example

200

OK

								{
  "richContentId" : string
}
							

400

Bad Request

								
							
Get a SMS send status

GET   /channels/sms/sends/{transactionId}/status

			https://api4.silverpop.com/rest/channels/sms/sends/{transactionId}/status
		
Keys
Path and Query parameters

transactionId

URL , required

A transaction id returned by POST /channels/sms/sends

Request code
Response model

200

No response was specified

Body

string

STRING , optional

Response example

200

No response was specified

								{
  "string" : string
}
							
Get a SMS send status

GET   /channels/sms/sends/{transactionId}/status

			https://api4.silverpop.com/rest/channels/sms/sends/{transactionId}/status
		
Keys
Path and Query parameters

transactionId

URL , required

A transaction id returned by POST /channels/sms/sends

Request code
Response model

200

No response was specified

Body

string

STRING , optional

Response example

200

No response was specified

								{
  "string" : string
}
							
Get Rich Content

GET   /channels/push/richcontent/{richContentId}

			https://api4.silverpop.com/rest/channels/push/richcontent/{richContentId}
		
Keys
Path and Query parameters

richContentId

URL , required

Request code
Response model

200

OK

Body

personalizationDefaults

ARRAY , optional

personalizationFormulas

ARRAY , optional

payload

object , optional

items

STRING , optional

items

STRING , optional

apns

object , optional

TemplateContent

OBJECT , optional

TemplateContent

OBJECT , optional

template

STRING , optional

Template name

content

object , optional

messagePreview

object , optional

messageDetails

object , optional

subject

STRING , optional

Subject of the message with optional personalization tags

previewContent

STRING , optional

Content of the preview with optional personalization tags

richContent

STRING , optional

Content for rich push

400

Bad Request

Body

Response example

200

OK

								{
  "personalizationDefaults" : [{
    "items" : string
  }],
  "personalizationFormulas" : [{
    "items" : string
  }],
  "payload" : {
    "apns" : {
    "template" : string,
    "content" : {
    "messagePreview" : {
    "subject" : string,
    "previewContent" : string
  },
    "messageDetails" : {
    "richContent" : string
  }
  }
  },
    "TemplateContent" : object,
    "TemplateContent" : object
  }
}
							

400

Bad Request

								
							
Get Rich Content

GET   /channels/push/richcontent/{richContentId}

			https://api4.silverpop.com/rest/channels/push/richcontent/{richContentId}
		
Keys
Path and Query parameters

richContentId

URL , required

Request code
Response model

200

OK

Body

personalizationDefaults

ARRAY , optional

personalizationFormulas

ARRAY , optional

payload

object , optional

items

STRING , optional

items

STRING , optional

apns

object , optional

TemplateContent

OBJECT , optional

TemplateContent

OBJECT , optional

template

STRING , optional

Template name

content

object , optional

messagePreview

object , optional

messageDetails

object , optional

subject

STRING , optional

Subject of the message with optional personalization tags

previewContent

STRING , optional

Content of the preview with optional personalization tags

richContent

STRING , optional

Content for rich push

400

Bad Request

Body

Response example

200

OK

								{
  "personalizationDefaults" : [{
    "items" : string
  }],
  "personalizationFormulas" : [{
    "items" : string
  }],
  "payload" : {
    "apns" : {
    "template" : string,
    "content" : {
    "messagePreview" : {
    "subject" : string,
    "previewContent" : string
  },
    "messageDetails" : {
    "richContent" : string
  }
  }
  },
    "TemplateContent" : object,
    "TemplateContent" : object
  }
}
							

400

Bad Request

								
							
Perform a push notification send to contacts

POST   /channels/push/sends

			https://api4.silverpop.com/rest/channels/push/sends
		
Keys
Request code
Request model

content

object , optional

simple

object , optional

apns

object , optional

aps

object , optional

alert

STRING , optional

Message to show on notification

badge

INTEGER , optional

data

OBJECT , optional

notification-action

object , optional

name

STRING , optional

Name of action to display on notification

value

STRING , optional

type

STRING , optional

Type of action to perform

inApp

object , optional

template

STRING , optional

InApp template name

content

OBJECT , optional

maxViews

INTEGER , optional

expirationDate

STRING , optional

rules

ARRAY , optional

gcm

object , optional

alert

object , optional

message

STRING , optional

Message of notification

subject

STRING , optional

Subject of notification

Action

OBJECT , optional

data

OBJECT , optional

InApp

OBJECT , optional

wns

object , optional

xml

STRING , optional

Windows push payload xml content

contentType

STRING , optional

Windows push payload content type

contentId

STRING , optional

UUID - representing delivery draft to load contents for push notification

inboxMessage

object , optional

richContentId

STRING , optional

Inbox message rich content id

expirationDate

STRING , optional

campaignName

STRING , optional

Campaign name

personalizationDefaults

ARRAY , optional

items

STRING , optional

channelQualifiers

ARRAY , optional

contacts

ARRAY , optional

Request example
{
  "content": {
    "simple": {
    "apns": {
    "aps": {
    "alert": string,
    "badge": integer
  },
    "data": object,
    "notification-action": {
    "name": string,
    "value": string,
    "type": string
  },
    "inApp": {
    "template": string,
    "content": object,
    "maxViews": integer,
    "expirationDate": string,
    "rules": []
  }
  },
    "gcm": {
    "alert": {
    "message": string,
    "subject": string,
    "Action": object
  },
    "data": object,
    "InApp": object
  },
    "wns": {
    "xml": string,
    "contentType": string
  }
  },
    "contentId": string,
    "inboxMessage": {
    "richContentId": string,
    "expirationDate": string
  }
  },
  "campaignName": string,
  "personalizationDefaults": [{
    "items": string
  }],
  "channelQualifiers": [],
  "contacts": []
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Perform a push notification send to contacts

POST   /channels/push/sends

			https://api4.silverpop.com/rest/channels/push/sends
		
Keys
Request code
Request model

content

object , optional

simple

object , optional

apns

object , optional

aps

object , optional

alert

STRING , optional

Message to show on notification

badge

INTEGER , optional

data

OBJECT , optional

notification-action

object , optional

name

STRING , optional

Name of action to display on notification

value

STRING , optional

type

STRING , optional

Type of action to perform

inApp

object , optional

template

STRING , optional

InApp template name

content

OBJECT , optional

maxViews

INTEGER , optional

expirationDate

STRING , optional

rules

ARRAY , optional

gcm

object , optional

alert

object , optional

message

STRING , optional

Message of notification

subject

STRING , optional

Subject of notification

Action

OBJECT , optional

data

OBJECT , optional

InApp

OBJECT , optional

wns

object , optional

xml

STRING , optional

Windows push payload xml content

contentType

STRING , optional

Windows push payload content type

contentId

STRING , optional

UUID - representing delivery draft to load contents for push notification

inboxMessage

object , optional

richContentId

STRING , optional

Inbox message rich content id

expirationDate

STRING , optional

campaignName

STRING , optional

Campaign name

personalizationDefaults

ARRAY , optional

items

STRING , optional

channelQualifiers

ARRAY , optional

contacts

ARRAY , optional

Request example
{
  "content": {
    "simple": {
    "apns": {
    "aps": {
    "alert": string,
    "badge": integer
  },
    "data": object,
    "notification-action": {
    "name": string,
    "value": string,
    "type": string
  },
    "inApp": {
    "template": string,
    "content": object,
    "maxViews": integer,
    "expirationDate": string,
    "rules": []
  }
  },
    "gcm": {
    "alert": {
    "message": string,
    "subject": string,
    "Action": object
  },
    "data": object,
    "InApp": object
  },
    "wns": {
    "xml": string,
    "contentType": string
  }
  },
    "contentId": string,
    "inboxMessage": {
    "richContentId": string,
    "expirationDate": string
  }
  },
  "campaignName": string,
  "personalizationDefaults": [{
    "items": string
  }],
  "channelQualifiers": [],
  "contacts": []
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Perform a SMS send to input contacts

POST   /channels/sms/sends

			https://api4.silverpop.com/rest/channels/sms/sends
		
Keys
Request code
Request model

content

STRING , optional

Content for SMS. E.g. Hey %%FIRST NAME%%! Happy birthday!!

personalizationDefaults

ARRAY , optional

items

STRING , optional

source

STRING , optional

Source attribute which will playback to Engage as part UB. E.g. transactionId=1234

channelQualifier

STRING , optional

SMS Program Identifier

contacts

ARRAY , optional

Request example
{
  "content": string,
  "personalizationDefaults": [{
    "items": string
  }],
  "source": string,
  "channelQualifier": string,
  "contacts": []
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Perform a SMS send to input contacts

POST   /channels/sms/sends

			https://api4.silverpop.com/rest/channels/sms/sends
		
Keys
Request code
Request model

content

STRING , optional

Content for SMS. E.g. Hey %%FIRST NAME%%! Happy birthday!!

personalizationDefaults

ARRAY , optional

items

STRING , optional

source

STRING , optional

Source attribute which will playback to Engage as part UB. E.g. transactionId=1234

channelQualifier

STRING , optional

SMS Program Identifier

contacts

ARRAY , optional

Request example
{
  "content": string,
  "personalizationDefaults": [{
    "items": string
  }],
  "source": string,
  "channelQualifier": string,
  "contacts": []
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Retrieve published messages for sms or push.

GET   /channels/{channel}/publishedmessages

			https://api4.silverpop.com/rest/channels/{channel}/publishedmessages
		
Keys
Path and Query parameters

channel

URL , required

Messages type we want to fetch, sms or push

Request code
Response model

200

No response was specified

Body

string

STRING , optional

Response example

200

No response was specified

								{
  "string" : string
}
							
Retrieve published messages for sms or push.

GET   /channels/{channel}/publishedmessages

			https://api4.silverpop.com/rest/channels/{channel}/publishedmessages
		
Keys
Path and Query parameters

channel

URL , required

Messages type we want to fetch, sms or push

Request code
Response model

200

No response was specified

Body

string

STRING , optional

Response example

200

No response was specified

								{
  "string" : string
}
							
Send a push notification to a contact source

POST   /channels/push/publishedmessages/{publishedMessageId}/sendjobs

			https://api4.silverpop.com/rest/channels/push/publishedmessages/{publishedMessageId}/sendjobs
		
Keys
Path and Query parameters

publishedMessageId

URL , required

Id of the published message to be sent

Request code
Request model

campaignName

STRING , optional

campaign name

folder

STRING , optional

message folder location

scheduledDate

STRING , optional

contactSourceId

INTEGER , optional

preBlockingHours

INTEGER , optional

messageName

STRING , optional

message name

Request example
{
  "campaignName": string,
  "folder": string,
  "scheduledDate": string,
  "contactSourceId": integer,
  "preBlockingHours": integer,
  "messageName": string
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Send a push notification to a contact source

POST   /channels/push/publishedmessages/{publishedMessageId}/sendjobs

			https://api4.silverpop.com/rest/channels/push/publishedmessages/{publishedMessageId}/sendjobs
		
Keys
Path and Query parameters

publishedMessageId

URL , required

Id of the published message to be sent

Request code
Request model

campaignName

STRING , optional

campaign name

folder

STRING , optional

message folder location

scheduledDate

STRING , optional

contactSourceId

INTEGER , optional

preBlockingHours

INTEGER , optional

messageName

STRING , optional

message name

Request example
{
  "campaignName": string,
  "folder": string,
  "scheduledDate": string,
  "contactSourceId": integer,
  "preBlockingHours": integer,
  "messageName": string
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Send a push notification with inline content to a contact source

POST   /channels/push/sendjobs

			https://api4.silverpop.com/rest/channels/push/sendjobs
		
Keys
Request code
Request model

campaignName

STRING , optional

campaign name

folder

STRING , optional

message folder location

scheduledDate

STRING , optional

content

object , optional

simple

object , optional

apns

object , optional

aps

object , optional

alert

STRING , optional

Message to show on notification

badge

INTEGER , optional

data

OBJECT , optional

notification-action

object , optional

name

STRING , optional

Name of action to display on notification

value

STRING , optional

type

STRING , optional

Type of action to perform

inApp

object , optional

template

STRING , optional

InApp template name

content

OBJECT , optional

maxViews

INTEGER , optional

expirationDate

STRING , optional

rules

ARRAY , optional

gcm

object , optional

alert

object , optional

message

STRING , optional

Message of notification

subject

STRING , optional

Subject of notification

Action

OBJECT , optional

data

OBJECT , optional

InApp

OBJECT , optional

wns

object , optional

xml

STRING , optional

Windows push payload xml content

contentType

STRING , optional

Windows push payload content type

inboxMessage

object , optional

richContentId

STRING , optional

Inbox message rich content id

expirationDate

STRING , optional

contactSourceId

INTEGER , optional

appKeys

ARRAY , optional

preBlockingHours

INTEGER , optional

messageName

STRING , optional

message name

Request example
{
  "campaignName": string,
  "folder": string,
  "scheduledDate": string,
  "content": {
    "simple": {
    "apns": {
    "aps": {
    "alert": string,
    "badge": integer
  },
    "data": object,
    "notification-action": {
    "name": string,
    "value": string,
    "type": string
  },
    "inApp": {
    "template": string,
    "content": object,
    "maxViews": integer,
    "expirationDate": string,
    "rules": []
  }
  },
    "gcm": {
    "alert": {
    "message": string,
    "subject": string,
    "Action": object
  },
    "data": object,
    "InApp": object
  },
    "wns": {
    "xml": string,
    "contentType": string
  }
  },
    "inboxMessage": {
    "richContentId": string,
    "expirationDate": string
  }
  },
  "contactSourceId": integer,
  "appKeys": [],
  "preBlockingHours": integer,
  "messageName": string
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Send a push notification with inline content to a contact source

POST   /channels/push/sendjobs

			https://api4.silverpop.com/rest/channels/push/sendjobs
		
Keys
Request code
Request model

campaignName

STRING , optional

campaign name

folder

STRING , optional

message folder location

scheduledDate

STRING , optional

content

object , optional

simple

object , optional

apns

object , optional

aps

object , optional

alert

STRING , optional

Message to show on notification

badge

INTEGER , optional

data

OBJECT , optional

notification-action

object , optional

name

STRING , optional

Name of action to display on notification

value

STRING , optional

type

STRING , optional

Type of action to perform

inApp

object , optional

template

STRING , optional

InApp template name

content

OBJECT , optional

maxViews

INTEGER , optional

expirationDate

STRING , optional

rules

ARRAY , optional

gcm

object , optional

alert

object , optional

message

STRING , optional

Message of notification

subject

STRING , optional

Subject of notification

Action

OBJECT , optional

data

OBJECT , optional

InApp

OBJECT , optional

wns

object , optional

xml

STRING , optional

Windows push payload xml content

contentType

STRING , optional

Windows push payload content type

inboxMessage

object , optional

richContentId

STRING , optional

Inbox message rich content id

expirationDate

STRING , optional

contactSourceId

INTEGER , optional

appKeys

ARRAY , optional

preBlockingHours

INTEGER , optional

messageName

STRING , optional

message name

Request example
{
  "campaignName": string,
  "folder": string,
  "scheduledDate": string,
  "content": {
    "simple": {
    "apns": {
    "aps": {
    "alert": string,
    "badge": integer
  },
    "data": object,
    "notification-action": {
    "name": string,
    "value": string,
    "type": string
  },
    "inApp": {
    "template": string,
    "content": object,
    "maxViews": integer,
    "expirationDate": string,
    "rules": []
  }
  },
    "gcm": {
    "alert": {
    "message": string,
    "subject": string,
    "Action": object
  },
    "data": object,
    "InApp": object
  },
    "wns": {
    "xml": string,
    "contentType": string
  }
  },
    "inboxMessage": {
    "richContentId": string,
    "expirationDate": string
  }
  },
  "contactSourceId": integer,
  "appKeys": [],
  "preBlockingHours": integer,
  "messageName": string
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Send a SMS message to a contact source

POST   /channels/sms/publishedmessages/{publishedMessageId}/sendjobs

			https://api4.silverpop.com/rest/channels/sms/publishedmessages/{publishedMessageId}/sendjobs
		
Keys
Path and Query parameters

publishedMessageId

URL , required

Id of the published message to be sent

Request code
Request model

folder

STRING , optional

message folder location

scheduledDate

STRING , optional

contactSourceId

INTEGER , optional

externalSystemReferenceId

STRING , optional

Provision for the calling system to pass a Reference Identifier

preBlockingHours

INTEGER , optional

externalSystemName

STRING , optional

Provision for the calling system to pass a Name representing the calling system

messageName

STRING , optional

message name

Request example
{
  "folder": string,
  "scheduledDate": string,
  "contactSourceId": integer,
  "externalSystemReferenceId": string,
  "preBlockingHours": integer,
  "externalSystemName": string,
  "messageName": string
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							
Send a SMS message to a contact source

POST   /channels/sms/publishedmessages/{publishedMessageId}/sendjobs

			https://api4.silverpop.com/rest/channels/sms/publishedmessages/{publishedMessageId}/sendjobs
		
Keys
Path and Query parameters

publishedMessageId

URL , required

Id of the published message to be sent

Request code
Request model

folder

STRING , optional

message folder location

scheduledDate

STRING , optional

contactSourceId

INTEGER , optional

externalSystemReferenceId

STRING , optional

Provision for the calling system to pass a Reference Identifier

preBlockingHours

INTEGER , optional

externalSystemName

STRING , optional

Provision for the calling system to pass a Name representing the calling system

messageName

STRING , optional

message name

Request example
{
  "folder": string,
  "scheduledDate": string,
  "contactSourceId": integer,
  "externalSystemReferenceId": string,
  "preBlockingHours": integer,
  "externalSystemName": string,
  "messageName": string
}
Response model

200

No response was specified

Body

Response example

200

No response was specified

								
							

Loading content...