Skip to content

Create announcement

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/announcement
curl --request POST \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/announcement \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data '{ "startDate": "", "endDate": "", "descriptions": [ "" ], "showTitle": false, "showAlways": false }'

Creates a new date-based announcement for the given property from the supplied request. Announcements can be scheduled for specific date ranges or configured to always display. Requires CONTENT:WRITE on the managing entity. Returns HTTP 201 with the created announcement including its generated identifier.

managingEntityIdentifier
required
string
""

Unique identifier of the property (managing entity) where the announcement will be created

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0
Media type application/json
object
startDate

Date when this announcement becomes active and visible to travelers.

string format: date
""
Example
2026-03-01
endDate

Date when this announcement expires and is no longer displayed.

string format: date
""
Example
2026-04-15
descriptions
required

List of all localized announcements.

Array<object>
>= 1 items <= 2147483647 items
object
name
required

Use as title or short text description

string
""
Example
An example title
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
Example
This is a longer description in the specified language.
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example
SYSTEM
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
showTitle

When true, the announcement title is displayed to travelers; when false, only the description content is shown.

boolean
Example
true
showAlways

When true, the announcement is always visible regardless of booking dates; when false, visibility is restricted to the configured start and end dates.

boolean
Example
false

Announcement created successfully

Media type application/json
object
id

Document UUID

string format: uuid
""
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
""
hotelIdentifier
required

Unique identifier of the property (managing entity) for which this announcement is configured.

string format: uuid
"" >= 1 characters
startDate

Date when this announcement becomes active and visible to travelers.

string format: date
""
endDate

Date when this announcement expires and is no longer displayed.

string format: date
""
descriptions
required

List of all localized announcements.

Array<object>
>= 1 items <= 2147483647 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
showTitle

When true, the announcement title is displayed to travelers; when false, only the description content is shown.

boolean
showAlways

When true, the announcement is always visible regardless of booking dates; when false, visibility is restricted to the configured start and end dates.

boolean
Example
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"hotelIdentifier": "",
"startDate": "",
"endDate": "",
"descriptions": [
""
],
"showTitle": false,
"showAlways": false
}

Invalid request: missing required fields, invalid dates, or endDate not after startDate

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

Insufficient permissions: CONTENT:WRITE not granted on the managing entity

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

Managing entity not found

Media type application/json
object
id

Document UUID

string format: uuid
""
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
""
hotelIdentifier
required

Unique identifier of the property (managing entity) for which this announcement is configured.

string format: uuid
"" >= 1 characters
startDate

Date when this announcement becomes active and visible to travelers.

string format: date
""
endDate

Date when this announcement expires and is no longer displayed.

string format: date
""
descriptions
required

List of all localized announcements.

Array<object>
>= 1 items <= 2147483647 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
showTitle

When true, the announcement title is displayed to travelers; when false, only the description content is shown.

boolean
showAlways

When true, the announcement is always visible regardless of booking dates; when false, visibility is restricted to the configured start and end dates.

boolean
Example
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"hotelIdentifier": "",
"startDate": "",
"endDate": "",
"descriptions": [
""
],
"showTitle": false,
"showAlways": false
}

Internal Server Error

object
Example generated
{}