openapi: 3.1.0
info:
title: conversations
version: '1.1'
servers:
- url: https://api.spredfast.com/v2
components:
securitySchemes:
sec0:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://example.com/oauth2/token
scopes: {}
security:
- sec0: []
paths:
/conversations/initiative/{initiative-id}/accountset:
get:
summary: Retrieve All Account Sets & Accounts Available
description: List all account sets and accounts available
operationId: accountset
parameters:
- name: initiative-id
in: path
description: The initiative you wish to target.
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"data\": [\n {\n \"accounts\": [\n {\n \"accountType\"\
: \"PAGE\",\n \"alias\": \"PCGazer\",\n \"id\": \"21365\",\n \
\ \"name\": \"Page: Example Inc.\",\n \"service\": \"FACEBOOK\",\n\
\ \"serviceId\": \"103129177815577\",\n \"sfEntityType\": \"Account\"\
,\n \"uniqueId\": \"2fefd6afe8261c2c162c0988c8f79727\"\n },\n \
\ {\n \"accountType\": \"USER\",\n \"id\": \"21366\",\n \
\ \"name\": \"ExampleInc\",\n \"service\": \"TWITTER\",\n \"\
serviceId\": \"1193602248087146499\",\n \"sfEntityType\": \"Account\",\n\
\ \"uniqueId\": \"495d056a96b49b82b8cd53145324c2d7\"\n }\n ],\n\
\ \"description\": \"\",\n \"id\": \"98330576\",\n \"name\": \"PCGazer\"\
,\n \"sfEntityType\": \"AccountSet\"\n }\n ],\n \"pagination\": {\n \"\
totalItems\": 1\n },\n \"status\": {\n \"succeeded\": true\n }\n}"
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
accounts:
type: array
items:
type: object
properties:
accountType:
type: string
example: PAGE
alias:
type: string
example: PCGazer
id:
type: string
example: '21365'
name:
type: string
example: 'Page: Example Inc.'
service:
type: string
example: FACEBOOK
serviceId:
type: string
example: '103129177815577'
sfEntityType:
type: string
example: Account
uniqueId:
type: string
example: 2fefd6afe8261c2c162c0988c8f79727
description:
type: string
example: ''
id:
type: string
example: '98330576'
name:
type: string
example: PCGazer
sfEntityType:
type: string
example: AccountSet
pagination:
type: object
properties:
totalItems:
type: integer
example: 1
default: 0
status:
type: object
properties:
succeeded:
type: boolean
example: true
default: true
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
/conversations/asset:
post:
summary: Create Text Asset
description: Create a new Text Content Center Asset
operationId: assets-create-text-asset
requestBody:
content:
application/json:
schema:
type: object
required:
- sfEntityType
- folderId
properties:
sfEntityType:
type: string
description: Specifies that this object is of Khoros Marketing entity type `Asset`.
Any other type will fail for this request.
default: Asset
id:
type: string
description: 'The ID of the asset within Khoros Marketing. **readOnly**: true'
folderId:
type: string
description: Which folder to place the asset in. This value must be present and a valid.
name:
type: string
description: The name of the Asset. See the [Name](#name-field) section below for additional
information.
intendedForPublishing:
type: boolean
description: Whether the asset can be used for publishing.
default: true
intendedForModeration:
type: boolean
description: Whether the asset can be used for Moderation.
default: true
contentLabels:
type: array
description: List of labels to apply to content generated with this asset.
items:
type: string
services:
type: array
description: The services to restrict this Asset to. **Allowed Values:** `FACEBOOK`,
`INSTAGRAM`, `PINTEREST`, `YOUTUBE`, `VK`, `MULTI_CHANNEL`, `SINAWEIBO`
items:
type: string
startDate:
type: string
description: 'The date and time when the asset becomes available for use. **Format**:
date-time'
endDate:
type: string
description: 'The date and time when the asset stops being available for use. **Format**:
date-time'
removalDate:
type: string
description: 'The date and time when the asset will be removed from Khoros Marketing.
**Format**: date-time'
text:
type: string
description: 'Text to go along with the asset. If this is Text Asset, this field is
required. **Character Limit**: 4000 **Visible On**: Text asset **Required for**: Text
asset'
image:
type: string
description: 'The publicly accessible URL for an Image Asset from within Khoros Marketing
Content Center. **Format**: uri **Visible On**: Image asset **readOnly**: true'
imageMedium:
type: string
description: 'The publicly accessible URL for a smaller version of the original Image
Asset from within Khoros Marketing Content Center. **Format**: uri **Visible On**:
Image asset **readOnly**: true'
imageThumb:
type: string
description: 'The publically accessible URL for a thumbnail of an Image Asset from within
Khoros Marketing Content Center. **Format**: uri **Visible On**: Image asset **readOnly**:
true'
video:
type: string
description: 'The publically accessible URL for a Video Asset from within Khoros Marketing
Content Center. **Format**: uri **Visible On**: Video asset **readOnly**: true'
videoThumb:
type: string
description: 'The publically accessible URL for a thumbnail of a Video Asset from within
Khoros Marketing Content Center. **Format**: uri **Visible On**: Video asset **readOnly**:
true'
externalId:
type: string
description: External ID to represent the ID of the asset outside of the system.
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"data\": {\n \"sfEntityType\": \"Asset\",\n \"id\": \"84d5cdbe-0f15-415e-80ea-examplede44f\"\
,\n \"companyId\": \"12\",\n \"folderId\": \"736\",\n \"name\": \"Asset Name\"\
,\n \"text\": \"Asset text value\",\n \"intendedForPublishing\": true,\n \
\ \"intendedForModeration\": true,\n \"createdDate\": 1551719642698,\n \"contentLabels\"\
: [\n \"coffee - espresso\"\n ]\n },\n \"status\": {\n \"succeeded\"\
: true\n }\n}"
schema:
type: object
properties:
data:
type: object
properties:
sfEntityType:
type: string
example: Asset
id:
type: string
example: 84d5cdbe-0f15-415e-80ea-examplede44f
companyId:
type: string
example: '12'
folderId:
type: string
example: '736'
name:
type: string
example: Asset Name
text:
type: string
example: Asset text value
intendedForPublishing:
type: boolean
example: true
default: true
intendedForModeration:
type: boolean
example: true
default: true
createdDate:
type: integer
example: 1551719642698
default: 0
contentLabels:
type: array
items:
type: string
example: coffee - espresso
status:
type: object
properties:
succeeded:
type: boolean
example: true
default: true
'406':
description: '406'
content:
text/plain:
examples:
Result:
value: "{\n \"status\": {\n \"error\": {\n \"code\": \"not_acceptable\",\n\
\ \"message\": \"Unable to parse the json you provided.\"\n },\n \"succeeded\"\
: false\n }\n}"
schema:
type: object
properties:
status:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: not_acceptable
message:
type: string
example: Unable to parse the json you provided.
succeeded:
type: boolean
example: false
default: true
deprecated: false
security: []
/conversations/asset?multipart:
post:
summary: Create Image or Video
description: Create a new image/video Content Center Asset
operationId: assets-create-image-or-video
requestBody:
content:
application/json:
schema:
type: object
required:
- sfEntityType
- folderId
properties:
sfEntityType:
type: string
description: Specifies that this object is of Khoros Marketing entity type `Asset`.
Any other type will fail for this request.
default: Asset
id:
type: string
description: 'The ID of the asset within Khoros Marketing. **readOnly**: true'
folderId:
type: string
description: Which folder to place the asset in. This value must be present and a valid.
name:
type: string
description: The name of the Asset. See the [Name](#name-field) section below for additional
information. **Character Limit:** 250
intendedForPublishing:
type: boolean
description: Whether the asset can be used for publishing.
default: true
intendedForModeration:
type: boolean
description: Whether the asset can be used for Moderation.
default: true
contentLabels:
type: array
description: List of labels to apply to content generated with this asset.
items:
type: string
services:
type: array
description: The services to restrict this Asset to. **Allowed Values:** `FACEBOOK`,
`INSTAGRAM`, `PINTEREST`, `YOUTUBE`, `VK`, `MULTI_CHANNEL`, `SINAWEIBO`
items:
type: string
startDate:
type: string
description: 'The date and time when the asset becomes available for use. **Format**:
date-time'
endDate:
type: string
description: 'The date and time when the asset stops being available for use. **Format**:
date-time'
removalDate:
type: string
description: 'The date and time when the asset will be removed from Khoros Marketing.
**Format**: date-time'
text:
type: string
description: 'Text to go along with the asset. If this is Text Asset, this field is
required. **Visible On**: Text asset **Required for**: Text asset **Character Limit:**
4000'
image:
type: string
description: 'The publicly accessible URL for an Image Asset from within Khoros Marketing
Content Center. **Format**: uri **Visible On**: Image asset **readOnly**: true'
imageMedium:
type: string
description: 'The publicly accessible URL for a smaller version of the original Image
Asset from within Khoros Marketing Content Center. **Format**: uri **Visible On**:
Image asset **readOnly**: true'
imageThumb:
type: string
description: 'The publically accessible URL for a thumbnail of an Image Asset from within
Khoros Marketing Content Center. **Format**: uri **Visible On**: Image asset **readOnly**:
true'
video:
type: string
description: 'The publically accessible URL for a Video Asset from within Khoros Marketing
Content Center. **Format**: uri **Visible On**: Video asset **readOnly**: true'
videoThumb:
type: string
description: 'The publically accessible URL for a thumbnail of a Video Asset from within
Khoros Marketing Content Center. **Format**: uri **Visible On**: Video asset **readOnly**:
true'
externalId:
type: string
description: External ID to represent the ID of the asset outside of the system.
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"data\": {\n \"sfEntityType\": \"Asset\",\n \"id\": \"84d5cdbe-0f15-415e-80ea-examplede44f\"\
,\n \"companyId\": \"12\",\n \"folderId\": \"736\",\n \"name\": \"Asset Name\"\
,\n \"text\": \"Asset text value\",\n \"intendedForPublishing\": true,\n \
\ \"intendedForModeration\": true,\n \"createdDate\": 1551719642698,\n \"contentLabels\"\
: [\n \"coffee - espresso\"\n ]\n },\n \"status\": {\n \"succeeded\"\
: true\n }\n}"
schema:
type: object
properties:
data:
type: object
properties:
sfEntityType:
type: string
example: Asset
id:
type: string
example: 84d5cdbe-0f15-415e-80ea-examplede44f
companyId:
type: string
example: '12'
folderId:
type: string
example: '736'
name:
type: string
example: Asset Name
text:
type: string
example: Asset text value
intendedForPublishing:
type: boolean
example: true
default: true
intendedForModeration:
type: boolean
example: true
default: true
createdDate:
type: integer
example: 1551719642698
default: 0
contentLabels:
type: array
items:
type: string
example: coffee - espresso
status:
type: object
properties:
succeeded:
type: boolean
example: true
default: true
deprecated: false
security: []
/conversations/asset/{assetId}:
get:
summary: Retrieve a Content Center Asset by ID
description: Gets a Content Center Asset by asset ID (including content label information)
operationId: assets-retrieve-a-content-center-asset-by-id
parameters:
- name: assetId
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"data\": {\n \"companyId\": \"389\",\n \"contentLabels\": [\n \
\ \"General Labels - Inspirations\"\n ],\n \"createdDate\": 1616437795210,\n\
\ \"description\": \"This is an asset description.\",\n \"folderId\": \"32252\"\
,\n \"id\": \"0e195f2b-1f47-40cd-ae44-example70c88\",\n \"image\": \"https://spredfast-download.s3.amazonaws.com/app3/389/IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-example70c88.jpg?AWSAccessKeyId=REDACTED_AWS_ACCESS_KEY_ID&Expires=1616441951&Signature=0DwGQR%2BDo00aDAbLSLszuBCe0Ow%3D\"\
,\n \"imageMedium\": \"https://spredfast-download.s3.amazonaws.com/app3/389/MEDIUM_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616441951&Signature=SrwJV726yQxCez%2FwAj2uiZDe8A8%3D\"\
,\n \"imageThumb\": \"https://spredfast-download.s3.amazonaws.com/app3/389/THUMB_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616441951&Signature=sOrgXXY2xLZK1wJC5H9v3DupakQ%3D\"\
,\n \"intendedForModeration\": true,\n \"intendedForPublishing\": true,\n \
\ \"name\": \"exampleav-klapin-SymZoeE8quA-unsplash\",\n \"services\": [\n \
\ \"FACEBOOK\"\n ],\n \"sfEntityType\": \"Asset\",\n \"text\": \"\"\n \
\ },\n \"status\": {\n \"succeeded\": true\n }\n}"
schema:
type: object
properties:
data:
type: object
properties:
companyId:
type: string
example: '389'
contentLabels:
type: array
items:
type: string
example: General Labels - Inspirations
createdDate:
type: integer
example: 1616437795210
default: 0
description:
type: string
example: This is an asset description.
folderId:
type: string
example: '32252'
id:
type: string
example: 0e195f2b-1f47-40cd-ae44-example70c88
image:
type: string
example: https://spredfast-download.s3.amazonaws.com/app3/389/IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-example70c88.jpg?AWSAccessKeyId=REDACTED_AWS_ACCESS_KEY_ID&Expires=1616441951&Signature=0DwGQR%2BDo00aDAbLSLszuBCe0Ow%3D
imageMedium:
type: string
example: https://spredfast-download.s3.amazonaws.com/app3/389/MEDIUM_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616441951&Signature=SrwJV726yQxCez%2FwAj2uiZDe8A8%3D
imageThumb:
type: string
example: https://spredfast-download.s3.amazonaws.com/app3/389/THUMB_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616441951&Signature=sOrgXXY2xLZK1wJC5H9v3DupakQ%3D
intendedForModeration:
type: boolean
example: true
default: true
intendedForPublishing:
type: boolean
example: true
default: true
name:
type: string
example: exampleav-klapin-SymZoeE8quA-unsplash
services:
type: array
items:
type: string
example: FACEBOOK
sfEntityType:
type: string
example: Asset
text:
type: string
example: ''
status:
type: object
properties:
succeeded:
type: boolean
example: true
default: true
deprecated: false
security: []
put:
summary: Update Existing Content Center Asset
description: Updates a Content Center Asset based on the JSON request body
operationId: assets-update-existing-content-center-asset
parameters:
- name: assetId
in: path
schema:
type: string
required: true
- name: removeImage
in: query
schema:
type: boolean
default: false
- name: removeVideo
in: query
required: true
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: object
required:
- folderId
- sfEntityType
properties:
folderId:
type: string
name:
type: string
description:
type: string
text:
type: string
sfEntityType:
type: string
description: '**Allowed Values**: Asset'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"data\": {\n \"companyId\": \"389\",\n \"createdDate\": 1616437795210,\n\
\ \"description\": \"This is an example image asset.\",\n \"folderId\": \"32252\"\
,\n \"id\": \"0e195f2b-1f47-40cd-ae44-a5e083070c88\",\n \"image\": \"https://spredfast-download.s3.amazonaws.com/app3/389/IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616442157&Signature=examplerqgMe7fxWfo6ckEzQ%2Bk%3D\"\
,\n \"imageMedium\": \"https://spredfast-download.s3.amazonaws.com/app3/389/MEDIUM_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616442157&Signature=examplez4IoJCKxOjnKEw3giFE%3D\"\
,\n \"imageThumb\": \"https://spredfast-download.s3.amazonaws.com/app3/389/THUMB_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616442157&Signature=examplejIGyN0tKoVjn9gSwisk%3D\"\
,\n \"intendedForModeration\": true,\n \"intendedForPublishing\": true,\n \
\ \"name\": \"Asset Image Example\",\n \"services\": [\n \"FACEBOOK\"\n \
\ ],\n \"sfEntityType\": \"Asset\",\n \"text\": \"\"\n },\n \"status\":\
\ {\n \"succeeded\": true\n }\n}"
schema:
type: object
properties:
data:
type: object
properties:
companyId:
type: string
example: '389'
createdDate:
type: integer
example: 1616437795210
default: 0
description:
type: string
example: This is an example image asset.
folderId:
type: string
example: '32252'
id:
type: string
example: 0e195f2b-1f47-40cd-ae44-a5e083070c88
image:
type: string
example: https://spredfast-download.s3.amazonaws.com/app3/389/IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616442157&Signature=examplerqgMe7fxWfo6ckEzQ%2Bk%3D
imageMedium:
type: string
example: https://spredfast-download.s3.amazonaws.com/app3/389/MEDIUM_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616442157&Signature=examplez4IoJCKxOjnKEw3giFE%3D
imageThumb:
type: string
example: https://spredfast-download.s3.amazonaws.com/app3/389/THUMB_IMAGE_ASSET/2021-03/0e195f2b-1f47-40cd-ae44-a5e083070c88.jpg?AWSAccessKeyId=exampleUS5KNJY7D7SQA&Expires=1616442157&Signature=examplejIGyN0tKoVjn9gSwisk%3D
intendedForModeration:
type: boolean
example: true
default: true
intendedForPublishing:
type: boolean
example: true
default: true
name:
type: string
example: Asset Image Example
services:
type: array
items:
type: string
example: FACEBOOK
sfEntityType:
type: string
example: Asset
text:
type: string
example: ''
status:
type: object
properties:
succeeded:
type: boolean
example: true
default: true
deprecated: false
security: []
/conversations/folder:
post:
summary: Create a New Content Asset Folder
description: Create a new custom asset folder where assets may be assigned
operationId: create-a-new-content-asset-folder
requestBody:
content:
application/json:
schema:
type: object
required:
- sfEntityType
properties:
name:
type: string
description:
type: string
sfEntityType:
type: string
description: '**Allowed Values:** AssetFolder'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"data\": {\n \"companyId\": \"389\",\n \"createdDate\": 1616447179440,\n\
\ \"description\": \"This is a new example folder.\",\n \"id\": \"32253\",\n\
\ \"name\": \"A New Folder\",\n \"sfEntityType\": \"AssetFolder\"\n },\n \"\
status\": {\n \"succeeded\": true\n }\n}"
schema:
type: object
properties:
data:
type: object
properties:
companyId:
type: string
example: '389'
createdDate:
type: integer
example: 1616447179440
default: 0
description:
type: string
example: This is a new example folder.
id:
type: string
# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spredfast/refs/heads/main/openapi/spredfast-conversations-api-openapi.yml