Skip to main content
PATCH
Change a campaign status

Authorizations

Authorization
string
header
required

Access token issued by auth.signIn. Expires; refresh it with auth.refresh.

Path Parameters

id
string
required

Identifier of the resource being addressed.

Minimum string length: 1

Body

application/json
status
enum<string>
required
Available options:
draft,
ready,
sent

Response

OK

id
string
required
Minimum string length: 1
title
string
required
Minimum string length: 1
message
string
required
Minimum string length: 1
callToAction
string
required
Minimum string length: 1
segmentId
string
required
Minimum string length: 1
segmentName
string
required
Minimum string length: 1
channel
enum<string>
required
Available options:
sms,
email,
push
tone
enum<string>
required
Available options:
professional,
friendly,
urgent,
promotional
status
enum<string>
required
Available options:
draft,
ready,
sent
objective
string
required
Minimum string length: 1
generatedAt
string
required
Minimum string length: 1
Last modified on October 6, 2026