SAM

Manage social assets in the Social Asset Manager. Supports creating, reading, updating, patching, and deleting assets, creating or updating social template assets, starting an asynchronous asset import from a URL, and polling import task status.

Operations

Create social asset

Request

Security

bearerAuth and apiKeyAuth

Bodyapplication/jsonrequired

idstringrequired

Id of the asset.

namestringrequired

Name of the asset.

descriptionstringrequired

Description for the asset.

statusstringrequired

Status of the asset.

taxonomyobject(Taxonomy)required

Taxonomy of the asset.

insightsobject

Collective insights of the posts on social channels. e.g. likes, comments, shares

validityobject(Validity)

Asset validity details. e.g expiry, available from

parentIdstring

Parent Asset Id.

assetSourcestring

Source of the Asset. e.g. SPRINKLR, GETTY, SHUTTERSTOCK

sourceIdstring

Source Id of the Asset.

externalMediaIdstring

Media Id from the external source, populated when assetSource is not SPRINKLR

actionStatsobject

Stats of the asset actions. e.g Download, Published

shareConfigsArray of objects(AssetShareConfig)

Asset share config

restrictedboolean

True if asset is restricted from publishing

lockedboolean

True if asset is locked

createdTimeinteger, (int64)

createdTime of Social Asset

modifiedTimeinteger, (int64)

modifiedTime of Social Asset

defaultLocalestring

Default locale for Social Asset

langVsTranslatedFieldValuesobject

Language vs Translated Metadata for Social Asset

approvedByUserinteger, (int64)

createdByUserinteger, (int64)

versionIdinteger, (int32)

assetTypestring(SocialAssetType)required

Type of the asset.

Enum:"PRESENTATION""PHOTO""VIDEO""AUDIO""FLASH""HTML""PDF""DOC""DOCX""EXCEL"

attachmentany(Attachment)required

lastModifiedByIdinteger, (int64)

Last Modified by for the asset

reportingStatsobject

Reporting stats of the asset

curl -i -X POST \
  https://dev-staging.sprinklr.com/_mock/apis/sprinklr-v3/sam \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "taxonomy": {
      "name": "string",
      "campaignId": "string",
      "subCampaignId": "string",
      "clientCustomProperties": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "partnerCustomProperties": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "tags": [
        "string"
      ],
      "urlShortenerId": "string"
    },
    "insights": {
      "property1": 0.1,
      "property2": 0.1
    },
    "validity": {
      "expiryTime": 0,
      "availableFrom": 0,
      "neverExpire": true,
      "visibleFrom": 0,
      "visibleTill": 0
    },
    "parentId": "string",
    "assetSource": "string",
    "sourceId": "string",
    "externalMediaId": "string",
    "actionStats": {
      "property1": 0.1,
      "property2": 0.1
    },
    "shareConfigs": [
      {
        "type": "string",
        "ids": [
          "string"
        ]
      }
    ],
    "restricted": true,
    "locked": true,
    "createdTime": 0,
    "modifiedTime": 0,
    "defaultLocale": "string",
    "langVsTranslatedFieldValues": {
      "property1": {
        "property1": "string",
        "property2": "string"
      },
      "property2": {
        "property1": "string",
        "property2": "string"
      }
    },
    "approvedByUser": 0,
    "createdByUser": 0,
    "versionId": 0,
    "assetType": "PRESENTATION",
    "attachment": {
      "type": "IMAGE",
      "assetId": "string",
      "attachmentOptions": [
        {
          "channelType": "FACEBOOK",
          "accountId": 0,
          "embeddable": true,
          "category": "string",
          "noStory": true,
          "secret": true,
          "blockSocialActions": true,
          "expirationEnabled": true,
          "expirationDate": 0,
          "deletePost": true
        }
      ],
      "url": "string",
      "urlHash": "string",
      "title": "string",
      "description": "string",
      "previewUrl": "string",
      "hashedPreviewUrl": "string",
      "mimeType": "string",
      "alternateText": "string",
      "height": 0.1,
      "width": 0.1,
      "encryptedUrl": "string",
      "sizeInBytes": 0
    },
    "lastModifiedById": 0,
    "reportingStats": {
      "property1": 0.1,
      "property2": 0.1
    }
  }'

Responses

Success

Bodyapplication/json