post https://api.spredfast.com/v2/conversations/initiative//message
Publish a new Khoros Marketing Messages for the target Initiative
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 |
|
videoTitle | string |
videoType | Optional enumerated string. Possible values:
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 |