Publish a New Message

Publish a new Khoros Marketing Messages for the target Initiative

Details

Content Object (one of the following)

discriminator: sfEntityType

Image Share

FieldType or value
sfEntityTypeImageShare
captionstring
altTextOptional string for the networks that support alt text for the image

Image Share List

sfEntityTypeImageShareList
imagesarray[object]Each object is an ImageShare as described above.

Video

To publish a video it is mandatory to specify the id of a previously uploaded video asset in the assetIds body field

sfEntityType

Video

videoTitle

string

videoType

Optional enumerated string.

Possible values:

  • REELS to publish instagram reels.

Otherwise don't include it.

descriptionstring
tagsstring. This is a required field. You can add multiple tags and delimit it by comma like tag1, tag2.
categorystring
captionsarray[caption]

YouTube

When YouTube is selected as the service, the value of the category field needs to match one of the keys listed in this table:

KeyDescription
AutosAutos & Vehicles
ComedyComedy
EducationEducation
EntertainmentEntertainment
FilmFilm & Animation
GamesGaming
HowtoHowto & Style
MusicMusic
NewsNews & Politics
NonprofitNonprofits & Activism
PeoplePeople & Blogs
AnimalsPets & Animals
TechScience & Technology
SportsSports
TravelTravel & Events

captions object

sfEntityTypeVideoCaptions
idlong - id an already uploaded captions file
defaultLocaleboolean - optional. Only one can be true if multiple captions are set on the same video to mark them as the default ones. Not all networks support multiple captions.

Status update (a text message with an optional link)

sfEntityTypeStatus
textstring
shareLinkobject

shareLink Object

urlstring
titlestring
descriptionstring
captionstring
thumbnailUrlstring

Carousel

sfEntityTypeCarousel
textstring
imagesarray[object]
shareLinkobject (same as status update)

carousel images Object

titlestring
linkUristring
callToActionobject
callToAction Object
typestring
linkstring
linkCaptionstring
Supported Values for the callToAction Object

The below tables list the User Interface (UI) Field value and its corresponding API value for the callToAction object field.

UI Field ValueCorresponding API Value
Apply NowAPPLY_NOW
Book NowBOOK_TRAVEL
Contact UsCONTACT_US
Donate NowDONATE_NOW
DownloadDOWNLOAD
Get OfferGET_OFFER
Get ShowtimesGET_SHOWTIMES
Learn MoreLEARN_MORE
Listen NowLISTEN_MUSIC
No ButtonNO_BUTTON
Request TimeREQUEST_TIME
Send MessageMESSAGE_PAGE
See MenuSEE_MENU
Shop NowSHOP_NOW
Sign UpSIGN_UP
SubscribeSUBSCRIBE
Watch MoreWATCH_MORE
Language
Click Try It! to start a request and see the response here!