Skip to content
Wink

Show Social Post Calendar

POST
/api/managing-entity/{managingEntityIdentifier}/studio/managed-social/post/calendar
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/company-1/studio/managed-social/post/calendar \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "startDate": "", "endDate": "" }'

Show posts for date range.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Load calendar for this ID

Example 
company-1

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”

Request body

Media type application/json
object
startDate
required

Start date to filter on.

string format: date-time
""
Example 
2017-12-01T00:00:000.000+0000
endDate
required

Start date to filter on.

string format: date-time
""
Example 
2017-12-31T23:59:59.999+0000

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
Array<object>
object
id

Document UUID

string
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
userIdentifier
required

The user ID that owns the account

string format: uuid
"" >= 1 characters
ownerIdentifier
required

The owner entity this entry associates with

string format: uuid
"" >= 1 characters
customizationIdentifier
required

The template identifier that was used to create this post

string format: uuid
"" >= 1 characters
status
required

Status of post.

string
""
Allowed values: DRAFT PENDING_APPROVAL APPROVED REJECTED PAUSED PUBLISHED FAILED
postType
required

The structural intent of this post.

string
default: TRANSACTIONAL
Allowed values: TRANSACTIONAL AWARENESS SENTIMENT
toneOfVoice
required

The language style used for this post.

string
default: NEUTRAL
Allowed values: NEUTRAL FRIENDLY LUXURY FOODIE ADVENTUROUS FAMILY ROMANTIC HUMOROUS ECO LOCAL_INSIDER INCLUSIVE BUDGET
type
required

Type of post.

string
default: MANUAL
Allowed values: MANUAL TRANSACTIONAL AWARENESS SENTIMENT
link

A link to go with the text

object
url
required

A url url

string
"" >= 1 characters
description

Description of url

string
""
caption

Top 5

string
""
location

Optional geo-location

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
descriptions
required

A single entry array under most circumstances in the language the post was created for.

Array<object>
>= 1 items
object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
multimedias
Array<object>

CDN image assets. Most social networks support more than one image [but no more than 10]

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

Currently ONLY using Cloudinary to store all image / video assets.

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
sort
required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32
default: 999
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
category

Supported OTA specification PIC code. See OTA geoname data

string
""
descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>
""
object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string
""
Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
userTags
Array<string>
hashTags
Array<string>
scheduledDate
required

ZoneId-aware date for exactly when the post goes out.

string format: date-time
""
timezone
required

Timezone code.

string
"" >= 1 characters
platform
required

Which platform to post to.

string
""
Allowed values: WINK_LINKS FACEBOOK INSTAGRAM
metadata

Extended metadata

object
key
additional properties
statusText

Platform response to go along with the status. Mostly for use with errors.

string
""
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "userIdentifier": "",
    "ownerIdentifier": "",
    "customizationIdentifier": "",
    "status": "DRAFT",
    "postType": "TRANSACTIONAL",
    "toneOfVoice": "NEUTRAL",
    "type": "MANUAL",
    "link": "",
    "location": "",
    "descriptions": [
      ""
    ],
    "multimedias": [
      null
    ],
    "userTags": [
      ""
    ],
    "hashTags": [
      ""
    ],
    "scheduledDate": "",
    "timezone": "",
    "platform": "WINK_LINKS",
    "metadata": "",
    "statusText": ""
  }
]

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}