Skip to content

Update status

PATCH
/api/managing-entity/{managingEntityIdentifier}/studio/managed-social/post/status
curl --request PATCH \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/managed-social/post/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data '{ "filter": "", "mode": "ALL", "postIdentifiers": [ "" ], "status": "DRAFT" }'

Bulk-updates the status (e.g. scheduled, paused, cancelled) of one or more posts for the account.

managingEntityIdentifier
required
string
""

Update posts for this managing entity ID

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Status update criteria and new status

Media type application/json
object
filter

Search filter criteria to identify posts to update (mutually exclusive with postIdentifiers)

object
skip

Number of records to be skipped by the pager.

integer format: int32
0
Example
0
take

Number of records to take.

integer format: int32
default: 30 >= 1 <= 180
Example
10
sort

Descriptors used for sorting result set.

Array<object>
""
object
dir

Descriptors used for sorting result set

string
""
Allowed values: asc desc
Example
asc
field

Data set field to sort on

string
""
Example
hotel.name
status

Filter by post status (APPROVED, DRAFT, PUBLISHED, CANCELLED, etc)

Array<string>
""
Allowed values: DRAFT PENDING_APPROVAL APPROVED REJECTED PAUSED PUBLISHED FAILED
Example
APPROVED
platform

Filter by target social platform

Array<string>
""
Allowed values: WINK_LINKS FACEBOOK INSTAGRAM
Example
WINK_LINKS
term

Full-text search keyword

string
""
Example
luxury accommodation
scheduledDate

Filter by post scheduled date range

object
startDate
required

Retrieve data range starting with and including this start date

string format: date
""
Example
2020-12-24
endDate
required

Retrieve data range ending with and including this end date

string format: date
""
Example
2020-12-31
mode

Mode of operation (e.g. bulk update)

string
""
Allowed values: ALL PAGE
postIdentifiers
Array<string>
status
required

New status to apply to selected posts (APPROVED, DRAFT, PUBLISHED, CANCELLED, etc)

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

OK

Media type application/json
object
ids
required
Array<string>
status
required

The status that was applied to these posts

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

Total number of posts updated in the database

integer format: int64
""
Example
{
"ids": [
""
],
"status": "DRAFT",
"count": ""
}

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"
}
}

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

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

Internal Server Error

object
Example generated
{}