POST api/v1/media/posts/{postId}/social-thumbnails/generate

Request Information

URI Parameters

Name	Description	Type	Additional information
postId		integer	Required

Body Parameters

GenerateSocialThumbnailRequest

Name	Type	Additional information
SourceMode	string	None.
Layout	string	None.
UsePostTitle	boolean	None.
CustomHeadline	string	None.
RenderOptions	ThumbnailRenderOptions	None.
RequestedBy	integer	None.
Background	boolean	None.
Force	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SourceMode": "sample string 1",
  "Layout": "sample string 2",
  "UsePostTitle": true,
  "CustomHeadline": "sample string 4",
  "RenderOptions": {
    "Version": 1,
    "Weight": "sample string 2",
    "Size": "sample string 3",
    "Alignment": "sample string 4",
    "HeadlineColor": "sample string 5",
    "PanelColor": "sample string 6",
    "AccentColor": "sample string 7"
  },
  "RequestedBy": 5,
  "Background": true,
  "Force": true
}

application/xml, text/xml

Sample:

<GenerateSocialThumbnailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/navtezcms.api.Media">
  <Background>true</Background>
  <CustomHeadline>sample string 4</CustomHeadline>
  <Force>true</Force>
  <Layout>sample string 2</Layout>
  <RenderOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/navtezcms.PhotoModule">
    <d2p1:AccentColor>sample string 7</d2p1:AccentColor>
    <d2p1:Alignment>sample string 4</d2p1:Alignment>
    <d2p1:HeadlineColor>sample string 5</d2p1:HeadlineColor>
    <d2p1:PanelColor>sample string 6</d2p1:PanelColor>
    <d2p1:Size>sample string 3</d2p1:Size>
    <d2p1:Version>1</d2p1:Version>
    <d2p1:Weight>sample string 2</d2p1:Weight>
  </RenderOptions>
  <RequestedBy>5</RequestedBy>
  <SourceMode>sample string 1</SourceMode>
  <UsePostTitle>true</UsePostTitle>
</GenerateSocialThumbnailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.