Skip to main content
POST
Create promotion

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Body

application/json
targetAudience
enum<string>
required

Audience for the promotion: all_subscribers targets new and expired subscribers, new_subscribers targets only new subscribers, expired_subscribers targets only expired subscribers.

Available options:
new_subscribers,
expired_subscribers,
all_subscribers
discount
object
required
offer
object
required
message
string
required

Promotion message

Maximum string length: 1000

Response

Successful response

items
object[]
required
page
object
required