Pause a Smart Campaign

post https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/pause

Pause a Smart Campaign. The Smart Campaign will change status to "Paused".

New Requests

Responses

Response body

object

int64

Campaign ID

name

string

Campaign name

mailingGroupId

int64

Client ID

description

string

Mailing description

status

string

Current campaign status

invalid activationRequired activated canceled paused running finished

type

string

Campaign type

regular event confirmation

created

date-time

Creation date

modified

date-time

Modification date

started

date-time

Start date of the campaign

finished

date-time

Finish date of the campaign

links

array of objects

links

object

uriBuilder

object

Has additional fields

rels

array of strings

rels

rel

string

type

string

params

object

Has additional fields

title

string

uri

recipientLists

object

nodeId

string

Node ID

successorNodeId

string

Successor node ID

recipientListIds

array of int64s

List of recipient list IDs

recipientListIds

links

array of objects

Links for further requests

links

object

uriBuilder

object

Has additional fields

rels

array of strings

rels

rel

string

type

string

params

object

Has additional fields

title

string

uri

gridLocation

object

Grid location point

targetGroups

array of objects

targetGroups

object

nodeId

string

Node ID

successorNodeId

string

Successor node ID

name

string

Target group name

targetGroup

object

links

array of objects

Links for further requests

links

object

uriBuilder

object

Has additional fields

rels

array of strings

rels

rel

string

type

string

params

object

Has additional fields

title

string

uri

gridLocation

object

Grid location point

messages

array of objects

messages

object

nodeId

string

Node ID

name

string

Mailing name

mailingId

int64

Mailing ID

description

string

Mailing description

mediaType

string

Media type of the mailing

status

string

Current status of the mailing

invalid activationRequired activated canceled paused running finished

created

date-time

Creation date

modified

date-time

Modification date

started

date-time

Start date of the mailing

finished

date-time

Finish date of the mailing

senderAddress

string

Email address of the sender

senderName

string

Sender name

replyToAddress

string

Email address for reply emails

replyToName

string

Name for reply emails

subject

object

Has additional fields

mediaCode

string

Media code of the mailing

format

string

Mailing format

dispatchOption

string

Dispatch options of the print mailing

dispatchStrategyOption

string

Dispatch strategy of the print mailing

accumulateMessagesForDays

int32

Number of messages per day

pushType

string

Push type (push message)

MOBILE WEB

icon

string

Icon (push message)

clickAction

string

Click action (push message)

archiveEnabled

boolean

Is mail archiving enabled

archivePeriod

string

Mail archiving period

ONE_MONTH TWO_MONTHS THREE_MONTHS SIX_MONTHS ONE_YEAR TWO_YEARS

smsParts

int32

Number of SMS parts

deeplinks

object

Deeplinks of the push message

Has additional fields

links

array of objects

Restful links

links

object

uriBuilder

object

Has additional fields

rels

array of strings

rels

rel

string

type

string

params

object

Has additional fields

title

string

uri

content

string

Mailing content

payload

object

Payload of the push message

Has additional fields

contentType

object

Content type of the mailing

expiry

date-time

Expiry date and time of the push message

attachmentIds

array of int64s

Comma-separated list of attachment IDs

attachmentIds

gridLocation

object

Grid location point

message

object

nodeId

string

Node ID

name

string

Mailing name

mailingId

int64

Mailing ID

description

string

Mailing description

mediaType

string

Media type of the mailing

status

string

Current status of the mailing

invalid activationRequired activated canceled paused running finished

created

date-time

Creation date

modified

date-time

Modification date

started

date-time

Start date of the mailing

finished

date-time

Finish date of the mailing

senderAddress

string

Email address of the sender

senderName

string

Sender name

replyToAddress

string

Email address for reply emails

replyToName

string

Name for reply emails

subject

object

Has additional fields

mediaCode

string

Media code of the mailing

format

string

Mailing format

dispatchOption

string

Dispatch options of the print mailing

dispatchStrategyOption

string

Dispatch strategy of the print mailing

accumulateMessagesForDays

int32

Number of messages per day

pushType

string

Push type (push message)

MOBILE WEB

icon

string

Icon (push message)

clickAction

string

Click action (push message)

archiveEnabled

boolean

Is mail archiving enabled

archivePeriod

string

Mail archiving period

ONE_MONTH TWO_MONTHS THREE_MONTHS SIX_MONTHS ONE_YEAR TWO_YEARS

smsParts

int32

Number of SMS parts

deeplinks

object

Deeplinks of the push message

Has additional fields

links

array of objects

Restful links

links

object

uriBuilder

object

Has additional fields

rels

array of strings

rels

rel

string

type

string

params

object

Has additional fields

title

string

uri

content

string

Mailing content

payload

object

Payload of the push message

Has additional fields

contentType

object

Content type of the mailing

expiry

date-time

Expiry date and time of the push message

attachmentIds

array of int64s

Comma-separated list of attachment IDs

attachmentIds

gridLocation

object

Grid location point

409

The Smart Campaign could not be paused. Ensure that the Smart Campaign has started and is in status "Sending".

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.campaign.episerver.net/rest/clientId/smartcampaigns/campaignId/pause \
3
     --header 'accept: application/json'

Select from the Examples drop-down list.

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Pause a Smart Campaign

200The Smart Campaign was paused successfully.