CMS Contents Variant

Get, update, or delete a managed content variant.

Resource

1/connect/cms/contents/variants/variantId

Available version

54.0

HTTP methods

GET, PUT, DELETE

In version 56.0 and later, you can upload binary files. To upload a binary file, you must send it in a multipart/form-data request. For information about how to create the multipart/form-data message, see Uploading Binary Files.

Request body for PUT

Root XML tag

<managedContentVariantUpdateInputRepresentation>

JSON example for version 60.0 and later

1{
2  "title":"Title of Document",
3  "urlName":"test-url",
4  "contentBody" : {
5    "bannerImage": { 
6      "source": { 
7        "type": "imageReference", 
8        "ref": { 
9           "contentKey": "MCZOCY2AM5PFBADN5UDRB53TLXR4" 
10        } 
11      }
12    },
13    "excerpt":"this is test excerpt",
14    "body":"&lt;p&gt;Test body&lt;/p&gt;"
15  }
16}

JSON example for version 54.0–59.0

1{
2  "title": "My Updated Title",
3  "urlName": "my_updated_url_name",
4  "contentBody": {
5     "bannerImage":"MCZOCY2AM5PFBADN5UDRB53TLXR4",
6     "featuredEvent":"MCZOCY2AM5PFBADN5UDRB53TLXR4",
7     "excerpt":"this is my updated excerpt",
8     "body":"&lt;p&gt;Test updated body&lt;/p&gt;"
9     }
10}

Properties

Name	Type	Description	Required or Optional	Available Version
`apiName`	String	API name of the managed content variant.	Optional	63.0
`contentBody`	Managed Content Body Input in version 60.0 and later Map<String, Object> in version 54.0–59.0	Body of the managed content variant.	Optional	54.0
`title`	String	Title of the managed content variant.	Optional	54.0
`urlName`	String	URL name of the managed content variant within the org.	Optional	54.0

Response body for GET and PUT

Managed Content Variant

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide

CMS Contents Variant