JSON File Format for Content in Salesforce CMS

Content Properties

The format of the JSON file depends on the content type—image, news, or custom content. Each one has different properties.

Here’s an example of the JSON structure for importing mixed content items in an array.

{
    "content": [{
            "contentKey": "MC4NFMB52LHFFWPNFNKHQJHLFBQM",
            "type": "cms_image",
            "urlName": "content1a",
            "body": {
                "title": "My Image",
                "altText": "My Image",
                "thumbUrl": "https://encrypted-tbn0.gstatic.com/images?q=R3RYwZIUV6wo_tQ&usq=CA",
                "source": {
                    "url": "https://encrypted-tbn0.gstatic.com/images?q=R3RYwZIUV6wo_tQ&usq=CA}"
                }
            }
        },
        {
            "contentKey": "MC4NFMB52LHFFWPNFNKHQKJLMNFR",
            "type": "news",
            "urlName": "content2a",
            "body": {
                "title": "My News Item",
                "body": "<p>This is the body of my news item, which includes an uploaded banner image.</p>",
                "bannerImage": {
                    "ref": "MCFQ2WJD3O6NGCXOI3DIOF4RJQOI"
                },
                "excerpt": "This is a summary of my news item."
            }
        }
    ]
}

Tip You can omit optional fields from the JSON.

cms_image Body Properties

The cms_image type has these body properties.

source

The source field represents an image node (IMG) within the cms_image content type. At least one source field is required.

Here’s an example of the JSON structure for importing several images in an array. Salesforce CMS assigns a content key to new content after import.

{
    "content": [{
            "type": "cms_image",
            "urlName": "lampplus",
            "body": {
                "title": "Uttermost Rovasenda Pale Mint Green Ceramic Table Lamp",
                "altText": "Uttermost Rovasenda Pale Mint Green Ceramic Table Lamp",
                "thumbUrl": "https://encrypted-tbn0.gstatic.com/images?q=R3RYwZIUV6wo_tQ&usq=CA",
                "source": {
                    "url": "https://encrypted-tbn0.gstatic.com/images?q=R3RYwZIUV6wo_tQ&usq=CA}"
                }
            }
        },
        {
            "type": "cms_image",
            "urlName": "lampplus",
            "body": {
                "title": "Modern Table Lamps Set of 2 with USB Gold Metal for Living Room Bedroom Bedside",
                "altText": "Modern Table Lamps Set of 2 with USB Gold Metal for Living Room Bedroom Bedside",
                "thumbUrl": "https://myimageurl.com/images/g/wP8AAOSw3S1ct-iC/s-l640.jpg",
                "source": {
                    "url": "https://myimageurl.com/images/g/wP8AAOSw3S1ct-iC/s-l640.jpg"
                }
            }
        },
        {
            "type": "cms_image",
            "urlName": "lampplus",
            "body": {
                "title": "Hanging Pendant Lamp with Bluetooth Accessibility",
                "altText": "Hanging Pendant Lamp with Bluetooth Accessibility",
                "source": {
                    "ref": "SummerCampaign/Sale/hangingpendantlamp.png"
                }
            }
        }
    ]
}

news Body Properties

The news type has these body properties.

bannerImage

The bannerImage field represents an image node (IMG) within the news content type.

Here’s an example of the JSON structure for a news item that references an image by using the image’s content key.

{
"content":[
    {
    "contentKey":"MC4NFMB52LHFFWPNFNKHQJHLFBQM",
    "type":"news",
    "urlName":"content1a",
    "body":{
        "title":"Content1", 
        "body":"<p>This is body with uploaded banner1.<\/p>", 
        "bannerImage": {
            "ref":"MCFQ2WJD3O6NGCXOI3DIOF4RJQOI"
            },
        "excerpt":"This is a summary of my news item."
        }
    }]
}

Here’s an example of the JSON structure for a news item that references an image in the rich text editor (RTE).

{
    "content": [{
        "contentKey": "MC4NFMB52OSDINTHIFEGINBVWTHY",
        "type": "news",
        "urlName": "content2a",
        "body": {
            "title": "Content 2",
            "body": "<p>This is body with an image reference inline.<\/p> <p><br><\/p> <p><img data-fileid=\"20YRM0000004MyW\" data-cms-filename=\"SalesforceLogo.png\"><\/img><\/p> <iframe frameborder=\"0\" scrolling=\"auto\" allowfullscreen=\"true\" src=\"https:\/\/www.youtube.com\/embed\/X1XM4PwKVn0?showinfo=0\" width=\"560px\" height=\"315px\"><\/iframe> <p><br><\/p>",
            "excerpt": "This is a summary of my news item."
        }
    }]
}

Here’s an example of the JSON structure for a news item that references an image by using the content key in the rich text editor (RTE).

{

"content": [{

"contentKey": "MC8HYNJ89QAZXSWEDCVFRTGBNHYU",

"type": "news",

"urlName": "content3a",

"body": {

"title": "Content 3",

"body": "<img src=’ ‘ data-contentKey=’ ‘MCFQ2WJD3O6NGCXOI3DIOF4RJQOI’>",

"excerpt": "This excerpt is a summary of my news item."

}

}]

}

Custom Content Body Properties

Your content needs a name, but the rest of the content type properties are up to you. You can set any nodes depending on the type of content that you want to import. Here are some example properties.

Note For custom content type, all optional fields can be defined as required.

dateTimeNode

The dateTimeNode field represents a managed content date and time node (DateTime) within the custom content type.

Here’s an example of the JSON structure for importing a custom content item. Salesforce CMS assigns a content key after import.

{
    "content": [{
        "type": "customContentType",
        "body": {
            "nameNode": "CustomContentImportTest",
            "urlNode": "http://www.exampletube.com/myVideo",
            "dateNode": "1994-07-01",
            "dateTimeNode": {
                "dateTimeValue": "2008-09-15T15:53:00.000Z",
                "timeZone": "America/Los_Angeles"
            }
        }
    }]
}

Note Sometimes, the JSON file might start with a hidden character called a byte order mark. This character is not visible in all text editors and it can cause the import to fail with a file read error. To fix this, save the file using a text editor that lets you choose the encoding UTF-8.