Skip to content
Wink

Show for account

GET
/api/managing-entity/{managingEntityIdentifier}/message/list
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/message/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

List the notifications addressed to a given managing entity, newest first.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Show all messages for this managing entity

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Notifications retrieved successfully

Media type application/json
Array<object>
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
""
userIdentifier
required

Owner identifier

string format: uuid
"" >= 1 characters
managingEntityIdentifier

ManagingEntity identifier

string format: uuid
""
name

Owner name

string
""
priority
required

Importance of message

string
""
Allowed values: HIGH MEDIUM LOW
type
required

Message type

string
""
Allowed values: ALERT MESSAGE FEATURE
recipientType
required

Recipient type

string
""
Allowed values: USER ACCOUNT
messageTemplateId
required

Message template

string
"" >= 1 characters
subject
required

Subject of message

string
"" >= 1 characters
body
required

Body of message

string
"" >= 1 characters
ctaUrl

Path to feature

string
""
read

AffiliateAccount read announcement

boolean
markedAsRemoved

Message marked as removed

boolean
notifyViaEmail

Also send email announcement

boolean
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "userIdentifier": "",
    "managingEntityIdentifier": "",
    "name": "",
    "priority": "HIGH",
    "type": "ALERT",
    "recipientType": "USER",
    "messageTemplateId": "",
    "subject": "",
    "body": "",
    "ctaUrl": "",
    "read": false,
    "markedAsRemoved": false,
    "notifyViaEmail": false
  }
]

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