Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Body

application/json
content
string
required
experienceId
string<uuid>
required
includeAudience
boolean
required
includeWaitlist
boolean
required
scheduledAt
string
required
timeZone
string
required
timingStrategy
any
required
title
string
required
type
enum<string>
required
Available options:
EMAIL,
SMS,
DIRECT,
FACEBOOK,
X,
INSTAGRAM,
LINKEDIN,
TIKTOK,
YOUTUBE
creativeDesignId
string<uuid> | null
creativeDocument
object | null
creativeTemplateKey
string | null
imageUrl
string | null
metadata
object | null
sequenceId
string<uuid> | null
shortContent
string | null
templateData
object | null

Response

Announcement created successfully

archived
boolean
required
content
string
required
Minimum string length: 1
createdAt
string<date-time>
required
createdBy
string
required
experienceId
string<uuid>
required
id
string<uuid>
required
includeAudience
boolean
required
includeWaitlist
boolean
required
isDefault
boolean
required
organizationId
string<uuid>
required
timeZone
string
required
Minimum string length: 1
title
string
required
Minimum string length: 1
type
enum<string>
required
Available options:
EMAIL,
SMS,
DIRECT,
FACEBOOK,
X,
INSTAGRAM,
LINKEDIN,
TIKTOK,
YOUTUBE
anchorEntity
enum<string> | null
Available options:
EXPERIENCE,
DISTRIBUTION
anchorMoment
enum<string> | null
Available options:
OPEN,
CLOSE,
SETTLE
creativeDesignId
string<uuid> | null
creativeDocument
object | null
creativeTemplateKey
string | null
distributionId
string<uuid> | null
distributionType
enum<string> | null
Available options:
QUEUE,
DRAW,
AUCTION,
APPOINTMENT,
TIMED_RELEASE
imageUrl
string<uri> | null
metadata
object | null
offsetSeconds
number | null
scheduledAt
string<date-time> | null
sequenceId
string<uuid> | null
shortContent
string | null
templateData
object | null
timingStrategy
enum<string>
default:POINT_IN_TIME
Available options:
POINT_IN_TIME,
RELATIVE
updatedAt
string<date-time> | null
updatedBy
string | null