Skip to content
Wink

Update

PUT
/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/{shortenedUrlIdentifier}
curl --request PUT \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/shortened-url/3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Edits an existing shortened URL’s slug and target by its identifier.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
managingEntityIdentifier
required
string format: uuid
""

Managing entity identifier that owns the shortened URL

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
shortenedUrlIdentifier
required
string format: uuid
""

Identifier of the shortened URL to update

Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”

Updated shortened URL details (title, slug, target, metadata)

Media typeapplication/json

Request payload for creating or updating a shortened URL entry

object
audioList

Open Graph audio media extracted from the target URL

Array<object>

Open Graph media asset (image, video, or audio)

object
alt

Alternative text description for accessibility

string
""
Example
The Siam Residences exterior view
height

Media height in pixels

string
""
Example
630
secureUrl

HTTPS URL of the media asset

string format: uri
""
Example
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
Example
image/jpeg
url
required

URL of the media asset

string format: uri
"" >= 1 characters
Example
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
width

Media width in pixels

string
""
Example
1200
Example
{
  "alt": "The Siam Residences exterior view",
  "height": "630",
  "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
  "type": "image/jpeg",
  "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
  "width": "1200"
}
descriptions
required

Localized descriptions of the shortened URL entry

Array<object>
>= 1 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example
SYSTEM
description
required

Longer text description

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

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
Example
en
md5ContentHash

The md5 hash of the name, description and language.

string
""
Example
d41d8cd98f00b204e9800998ecf8427e
name
required

Use as title or short text description

string
""
Example
An example title
Example
{
  "creator": "USER",
  "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.",
  "language": "en",
  "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82",
  "name": "Deluxe River View Suite"
}
entityId

Entity identifier that the uniqueId originates from. Omit for type=URL, required for other types.

string format: uuid
""
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
imageList

Open Graph images extracted from the target URL

Array<object>

Open Graph media asset (image, video, or audio)

object
alt

Alternative text description for accessibility

string
""
Example
The Siam Residences exterior view
height

Media height in pixels

string
""
Example
630
secureUrl

HTTPS URL of the media asset

string format: uri
""
Example
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
Example
image/jpeg
url
required

URL of the media asset

string format: uri
"" >= 1 characters
Example
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
width

Media width in pixels

string
""
Example
1200
Example
{
  "alt": "The Siam Residences exterior view",
  "height": "630",
  "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
  "type": "image/jpeg",
  "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
  "width": "1200"
}
metadata

Extended metadata key-value pairs (e.g., seo keywords, tags)

object
key
additional properties
multimedias

Primary media assets associated with this shortened URL

Array<object>

Multimedia that contains less information than Multimedia object

object
angle

Media angle

string
""
Example
-90
attribution

Whether image has attribution properties

Array<object>
""
object
name
required

Name of contributor

string
"" >= 1 characters
Example
Samuel Adams
url

URL to contributor

string format: uri
""
Example
https://maps.google.com/maps/contrib/111628493169070103594
Example
{
  "name": "Samuel Adams",
  "url": "https://maps.google.com/maps/contrib/111628493169070103594"
}
category

Supported OTA specification PIC code. See OTA geoname data

string
""
Example
1
descriptions

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

Array<object>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example
SYSTEM
description
required

Longer text description

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

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
Example
en
md5ContentHash

The md5 hash of the name, description and language.

string
""
Example
d41d8cd98f00b204e9800998ecf8427e
name
required

Use as title or short text description

string
""
Example
An example title
Example
{
  "creator": "USER",
  "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.",
  "language": "en",
  "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82",
  "name": "Deluxe River View Suite"
}
height
required

Media height in pixels.

integer format: int32
"" >= 1
Example
1600
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
Example
cloudinary-image-1
isLandscape

True if media width is greater or equal to height

boolean
Example
true
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
Example
LIFESTYLE_HEALTH_FITNESS
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51
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
Example
true
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
Example
10
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
Example
CLOUDINARY
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
Example
IMAGE
width
required

Media width in pixels.

integer format: int32
"" >= 1
Example
2560
Example
{
  "angle": null,
  "attribution": [],
  "category": "2",
  "descriptions": [
    {
      "description": "Elegant lobby of The Siam Residences",
      "language": "en",
      "title": "Lobby Entrance"
    }
  ],
  "height": 1600,
  "identifier": "the-siam-residences/lobby-entrance",
  "isLandscape": true,
  "lifestyleType": null,
  "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
  "published": true,
  "sort": 10,
  "source": "CLOUDINARY",
  "type": "IMAGE",
  "width": 2560
}
title
required

Display name for this shortened URL

string
"" >= 1 characters
Example
The Siam Residences, Bangkok
type
required

Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.)

string
""
Allowed values: SELLABLE_INVENTORY_SLUG SELLABLE_SUPPLIER_SLUG AFFILIATE_ACCOUNT_SLUG SYNDICATED_ITEM_SLUG URL
Example
URL
uniqueId
required

URL-friendly slug that uniquely identifies this entry within the owner’s account

string
"" >= 1 characters
Example
the-siam-residences-promo
url

Target URL to redirect to. Required when type=URL, omit for other types.

string format: uri
""
Example
https://www.thesiamresidences.com/luxury-stay
videoList

Open Graph videos extracted from the target URL

Array<object>

Open Graph media asset (image, video, or audio)

object
alt

Alternative text description for accessibility

string
""
Example
The Siam Residences exterior view
height

Media height in pixels

string
""
Example
630
secureUrl

HTTPS URL of the media asset

string format: uri
""
Example
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
Example
image/jpeg
url
required

URL of the media asset

string format: uri
"" >= 1 characters
Example
https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg
width

Media width in pixels

string
""
Example
1200
Example
{
  "alt": "The Siam Residences exterior view",
  "height": "630",
  "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
  "type": "image/jpeg",
  "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
  "width": "1200"
}
Example
{
  "audioList": [
    {
      "alt": "The Siam Residences exterior view",
      "height": "630",
      "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "type": "image/jpeg",
      "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "width": "1200"
    }
  ],
  "descriptions": [
    {
      "creator": "USER",
      "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.",
      "language": "en",
      "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82",
      "name": "Deluxe River View Suite"
    }
  ],
  "entityId": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
  "imageList": [
    {
      "alt": "The Siam Residences exterior view",
      "height": "630",
      "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "type": "image/jpeg",
      "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "width": "1200"
    }
  ],
  "multimedias": [
    {
      "angle": null,
      "attribution": [],
      "category": "2",
      "descriptions": [
        {
          "description": "Elegant lobby of The Siam Residences",
          "language": "en",
          "title": "Lobby Entrance"
        }
      ],
      "height": 1600,
      "identifier": "the-siam-residences/lobby-entrance",
      "isLandscape": true,
      "lifestyleType": null,
      "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
      "published": true,
      "sort": 10,
      "source": "CLOUDINARY",
      "type": "IMAGE",
      "width": 2560
    }
  ],
  "title": "The Siam Residences, Bangkok",
  "type": "URL",
  "uniqueId": "the-siam-residences-promo",
  "url": "https://www.thesiamresidences.com/luxury-stay",
  "videoList": [
    {
      "alt": "The Siam Residences exterior view",
      "height": "630",
      "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "type": "image/jpeg",
      "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "width": "1200"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

The shortened URL after applying the requested changes

Media typeapplication/json

Lightweight, read-only projection of a shortened URL, used by cross-domain consumers.

object
audioList

Open Graph audio media extracted from the target URL.

Array<object>
""

Open Graph media asset (image, video, or audio)

object
alt

Alternative text description for accessibility

string
""
height

Media height in pixels

string
""
secureUrl

HTTPS URL of the media asset

string format: uri
""
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
url
required

URL of the media asset

string format: uri
"" >= 1 characters
width

Media width in pixels

string
""
createdDate

Datetime this record was first created

string | null format: date-time
""
descriptions

Localized descriptions of the shortened URL entry.

Array<object>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
description
required

Longer text description

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

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
md5ContentHash

The md5 hash of the name, description and language.

string
""
name
required

Use as title or short text description

string
""
entityId

Entity identifier that the uniqueId originates from. Empty for type=URL.

string format: uuid
""
id

Unique identifier for this record.

string format: uuid
""
imageList

Open Graph images extracted from the target URL.

Array<object>
""

Open Graph media asset (image, video, or audio)

object
alt

Alternative text description for accessibility

string
""
height

Media height in pixels

string
""
secureUrl

HTTPS URL of the media asset

string format: uri
""
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
url
required

URL of the media asset

string format: uri
"" >= 1 characters
width

Media width in pixels

string
""
lastUpdate

Datetime this record was last updated

string | null format: date-time
""
metadata

Extended metadata key-value pairs (e.g., seo keywords, tags).

object
key
additional properties
multimedias

Primary media assets associated with this shortened URL.

Array<object>
""

Multimedia that contains less information than Multimedia object

object
angle

Media angle

string
""
attribution

Whether image has attribution properties

Array<object>
""
object
name
required

Name of contributor

string
"" >= 1 characters
url

URL to contributor

string format: uri
""
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>
""

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
description
required

Longer text description

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

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
md5ContentHash

The md5 hash of the name, description and language.

string
""
name
required

Use as title or short text description

string
""
height
required

Media height in pixels.

integer format: int32
"" >= 1
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

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
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
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
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
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

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

Media width in pixels.

integer format: int32
"" >= 1
ownerIdentifier

Managing entity / owner identifier that owns this shortened URL.

string format: uuid
""
previousUniqueIds

Previous URL slugs maintained for SEO and backward compatibility.

Array<string>
""
title

Display name of the shortened URL.

string
""
type

Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.).

string
""
Allowed values: SELLABLE_INVENTORY_SLUG SELLABLE_SUPPLIER_SLUG AFFILIATE_ACCOUNT_SLUG SYNDICATED_ITEM_SLUG URL
uniqueId

URL-friendly slug that uniquely identifies this entry within the owner’s account.

string
""
url

Target URL to redirect to. Required when type=URL, omitted for other types.

string format: uri
""
userIdentifier

Creator of this shortened URL.

string format: uuid
""
version

Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.

integer | null format: int64
""
videoList

Open Graph videos extracted from the target URL.

Array<object>
""

Open Graph media asset (image, video, or audio)

object
alt

Alternative text description for accessibility

string
""
height

Media height in pixels

string
""
secureUrl

HTTPS URL of the media asset

string format: uri
""
type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string
""
url
required

URL of the media asset

string format: uri
"" >= 1 characters
width

Media width in pixels

string
""
key
additional properties
""
Example
{
  "audioList": [
    {
      "alt": "The Siam Residences exterior view",
      "height": "630",
      "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "type": "image/jpeg",
      "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "width": "1200"
    }
  ],
  "createdDate": "2026-01-14T09:30:00",
  "descriptions": [
    {
      "creator": "USER",
      "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.",
      "language": "en",
      "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82",
      "name": "Deluxe River View Suite"
    }
  ],
  "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47",
  "imageList": [
    {
      "alt": "The Siam Residences exterior view",
      "height": "630",
      "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "type": "image/jpeg",
      "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "width": "1200"
    }
  ],
  "lastUpdate": "2026-02-03T16:45:12",
  "multimedias": [
    {
      "angle": null,
      "attribution": [],
      "category": "2",
      "descriptions": [
        {
          "description": "Elegant lobby of The Siam Residences",
          "language": "en",
          "title": "Lobby Entrance"
        }
      ],
      "height": 1600,
      "identifier": "the-siam-residences/lobby-entrance",
      "isLandscape": true,
      "lifestyleType": null,
      "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
      "published": true,
      "sort": 10,
      "source": "CLOUDINARY",
      "type": "IMAGE",
      "width": 2560
    }
  ],
  "version": 3,
  "videoList": [
    {
      "alt": "The Siam Residences exterior view",
      "height": "630",
      "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "type": "image/jpeg",
      "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
      "width": "1200"
    }
  ]
}

400

Section titled “400”

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

401

Section titled “401”

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

403

Section titled “403”

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

404

Section titled “404”

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

405

Section titled “405”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

409

Section titled “409”

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

415

Section titled “415”

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

500

Section titled “500”

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

503

Section titled “503”

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example