Skip to content
Wink

Retrieve a campaign by its ID

GET
/api/public/campaign/{secureCode}
 
curl --request GET \
  --url https://api.wink.travel/api/public/campaign/example

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
secureCode
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type */*
object
campaignId

Campaign identifier

string
""
Example 
campaign-456
hotelName

Name of the hotel associated with this campaign

string
""
Example 
The Grand Hotel
posts

List of post assets belonging to this campaign

Array<object>
""
object
id

Post identifier

string
""
Example 
post-123
imageUrl

URL of the post image

string
""
Example 
https://cdn.example.com/image.jpg
imageAlt

Alt text for the post image

string
""
Example 
Hotel exterior at sunset
downloadFileName

Suggested file name when downloading the image

string
""
Example 
hotel-sunset.jpg

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