Skip to main content
PATCH
Update a campaign

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Path Parameters

campaignKey
string
required

Campaign key (e.g. APIT-001).

Body

application/json
name
string | null
Maximum string length: 200
subject
string | null
Maximum string length: 500
previewText
string | null
contentJson
string | null
contentText
string | null
fromEmail
string | null
fromName
string | null
topicIds
string<uuid>[] | null
segmentIds
string<uuid>[] | null
sendStrategy
enum<string> | null
Available options:
DRAFT,
IMMEDIATE,
SCHEDULED
scheduledAt
string<date-time> | null

Response

Updated campaign

id
string<uuid>
campaignKey
string | null
name
string
subject
string | null
previewText
string | null
contentJson
string | null
contentText
string | null
status
string
sendStrategy
string | null
topicIds
string<uuid>[] | null
segmentIds
string<uuid>[] | null
estimatedRecipientCount
integer<int64> | null
scheduledAt
string<date-time> | null
completedAt
string<date-time> | null
fromEmail
string | null
fromName
string | null
preSendScore
integer | null
preSendStatus
string | null
createdAt
string<date-time>
updatedAt
string<date-time>