Publish a New Message

post https://api.spredfast.com/v2/conversations/initiative/{initiativeId}/message

Publish a new Khoros Marketing Messages for the target Initiative

time	status	user agent
Retrieving recent requests…

Loading…

Details

Content Object (one of the following)

discriminator: sfEntityType

Image Share

Field	Type or value
sfEntityType	`ImageShare`
caption	string
altText	Optional string for the networks that support alt text for the image

Image Share List


sfEntityType	`ImageShareList`
images	array[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.
description	string
tags	string. This is a required field. You can add multiple tags and delimit it by comma like `tag1, tag2`.
category	string
captions	array[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:

Key	Description
`Autos`	Autos & Vehicles
`Comedy`	Comedy
`Education`	Education
`Entertainment`	Entertainment
`Film`	Film & Animation
`Games`	Gaming
`Howto`	Howto & Style
`Music`	Music
`News`	News & Politics
`Nonprofit`	Nonprofits & Activism
`People`	People & Blogs
`Animals`	Pets & Animals
`Tech`	Science & Technology
`Sports`	Sports
`Travel`	Travel & Events

captions object


sfEntityType	`VideoCaptions`
id	long - id an already uploaded captions file
defaultLocale	boolean - 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)


sfEntityType	`Status`
text	string
shareLink	object

shareLink Object


url	string
title	string
description	string
caption	string
thumbnailUrl	string

Carousel


sfEntityType	`Carousel`
text	string
images	array[object]
shareLink	object (same as status update)

carousel images Object


title	string
linkUri	string
callToAction	object

callToAction Object


type	string
link	string
linkCaption	string

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 Value	Corresponding API Value
Apply Now	APPLY_NOW
Book Now	BOOK_TRAVEL
Contact Us	CONTACT_US
Donate Now	DONATE_NOW
Download	DOWNLOAD
Get Offer	GET_OFFER
Get Showtimes	GET_SHOWTIMES
Learn More	LEARN_MORE
Listen Now	LISTEN_MUSIC
No Button	NO_BUTTON
Request Time	REQUEST_TIME
Send Message	MESSAGE_PAGE
See Menu	SEE_MENU
Shop Now	SHOP_NOW
Sign Up	SIGN_UP
Subscribe	SUBSCRIBE
Watch More	WATCH_MORE

Path Params

initiativeId

string

required

The initiative you wish to target. Format: int64

Body Params

sfEntityType

string

Khoros Marketing internal entity type. Allowed Values: Message

string

title

string

labels

string

service

string

Defaults to TWITTER

Social network to publish to. Allowed Values: TWITTER, FACEBOOK, GOOGLEPLUS, SINAWEIBO, LINKEDIN, MULTI_CHANNEL, PINTEREST, YOUTUBE, VK, TIKTOK

targetAccountIds

array of strings

targetAccountIds

organicVisibility

string

AllowedValues: VISIBLE, INVISIBLE, VISIBLE_POST_PUBLISH

status

string

Defaults to DRAFT

Allowed Values: DRAFT, PENDING, AWAITING_APPROVAL, REJECTED, PUBLISHED, ERROR, DELETED, NATIVELY_SCHEDULED

delegationStatus

string

Allowed Values: NOT_DELEGATED, SCHEDULED_FOR_DELEGATION, DELEGATION_FAILED, DELEGATED

publicationResults

array of objects

publicationResults

scheduledPublishDate

string

Format: date-time

callbacks

array of strings

uniqueItems: true uniqueItems: true Callback URLs need to be a POST type. Other types of URLs may result in an error response.

callbacks

targetingProfile

object

assetIds

array of strings

Array of content center assets ids to include in the message. One asset id of an asset of type video is required when publishing video.

assetIds

planId

string

nativeScheduling

boolean

sponsor

object

A Sponsor for the Message. Currently, we only support attaching a single sponsor when posting to only Facebook verified Pages (a.k.a. Facebook Branded Content, see https://www.facebook.com/facebookmedia/get-started/branded-content for more info), so any attempt to use it either for other Social Networks or including targets that don’t comply with this rule, will result in an error from the back-end. Note that the Sponsor itself is not restricted to be a verified page, so it could be a regular (non-verified) page or a regular user. As an example, a post could be created, targeting the Facebook verified page of @LeoMessi and that post could be sponsored by @nike.

publisherIds

array of strings

publisherIds

notes

array of objects

notes

Response

Language


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.spredfast.com/v2/conversations/initiative/initiativeId/message \
3
     --header 'accept: text/plain' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "service": "TWITTER",
8
  "status": "DRAFT"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

Details

Content Object (one of the following)

Image Share

Image Share List

Video

YouTube

captions object

Status update (a text message with an optional link)

shareLink Object

Carousel

carousel images Object

callToAction Object

Supported Values for the callToAction Object

200200