Add City

PATCH

/api/managing-entity/{managingEntityIdentifier}/fix/city

const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/fix/city';
const options = {
  method: 'PATCH',
  headers: {
    'Wink-Version': '2.0',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: 'null'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/fix/city \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Add city record profile.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

UUID of the managing entity whose city to update.

Example

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

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

GeoName city to associate with the managing entity

application/json

Request body for updating the city associated with a managing entity.

object

geoNameId

required

GeoNames identifier for the city to associate with the managing entity.

string

"" >= 1 characters

Example

{
  "geoNameId": "1609350"
}

Responses

200

Managing entity updated with the new city.

application/json

Lightweight projection of a managing entity, used by consumers outside the managing-entity module.

object

accountEmail

required

Primary email address for account communications, KYC documents, and compliance notices.

string format: email

"" >= 1 characters

accountPhoneNumber

Primary phone number for KYC verification and account support.

string

accounts

Array<object>

A sub-account of a managing entity, representing one of its functional roles (affiliate, property, or payment).

object

identifier

required

Entity ID should be the same as parent but can be different.

string format: uuid

"" >= 1 characters

type

required

Type of entity (e.g. PROPERTY, AFFILIATE, PAYMENT).

string

Allowed values: AFFILIATE PROPERTY PAYMENT

address

Account address. Usually the business address.

object

address1

Address line 1

string

address2

Address line 2

string

city

City name

string

country

Country

string

countryCode

Country

string

"" /^[A-Z]{2}$/

county

County

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

postalCode

Postal / zip code

string

state

State

string

bankAccounts

Array<object>

Bank accounts used for payouts.

object

accountHolderName

required

Name of the bank account holder.

string

"" >= 1 characters

accountNumber

required

Bank account number or IBAN. In all EU countries, this is the IBAN; in other countries, the routing number also applies.

string

"" >= 1 characters

address

Recipient bank account address. Optional; recommended by Revolut and required by some payout corridors.

object

address1

Address line 1

string

address2

Address line 2

string

city

City name

string

country

Country

string

countryCode

Country

string

"" /^[A-Z]{2}$/

county

County

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

postalCode

Postal / zip code

string

state

State

string

countryCode

required

ISO 3166-1 alpha-2 country code (e.g. US, GB, TH, JP).

string

"" >= 1 characters /^[A-Z]{2}$/

currencyCode

required

ISO 4217 currency code (e.g. USD, EUR, THB).

string

"" >= 1 characters /^[A-Z]{3}$/

identifier

required

Unique bank account identifier

string format: uuid

"" >= 1 characters

revolutCounterpartyId

Revolut counterparty ID assigned after the first successful payout is initiated. Null until first Revolut payout.

string | null

routingNumber

Bank account routing number (US), sort code (UK/HK), or Zengin code (JP).

string

swiftCode

Bank SWIFT code (BIC), uniquely identifying the bank and branch.

string

city

required

City location.

object

asciiName

Ascii name of city

string

country

Country

object

capital

Country capital

string

continent

Continent code

string

currencyCode

Currency code

string

"" /^[A-Z]{3}$/

currencyName

Currency name

string

geoNameId

Country GeoNames identifier

string

iso

ISO code

string

name

Country name

string

countryCode

ISO 3166-1 alpha-2 country code for the country this location belongs to

string

"" /^[A-Z]{2}$/

featureCode

GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)

string

geoNameId

GeoName identifier

string

location

Coordinate points of the city

object

coordinates

Array<number>

type

string

number format: double

name

Name of city

string

subCountry

Country sub division

object

asciiName

Sub-country ascii name

string

geoNameId

Sub-country GeoNames identifier

string

name

Sub-country name

string

subSubCountry

Country sub sub division

object

asciiName

ASCII-transliterated name of the county or district, safe for URLs and sorting

string

geoNameId

GeoNames.org unique identifier for this subdivision

string

name

Official name of the county or district in its local script

string

timezone

IANA timezone identifier for the location

string

type

GeoNameLightweight type

string

Allowed values: CITY ISLAND OTHER

urlName

Url name

string

"" /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

createdDate

Datetime this record was first created

string | null format: date-time

currencyCode

required

ISO 4217 primary currency code for accounting and payouts.

string

"" >= 1 characters

description

Short description reflecting the entity’s brand and positioning.

string

Unique identifier for this record.

string format: uuid

lastUpdate

Datetime this record was last updated

string | null format: date-time

legalName

Legal/registered name if different from display name.

string

logo

Entity logo.

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

managedBy

If another company entity is managing this property on behalf of it, specified here.

object

commissionInPercent

required

Agency commission

number

identifier

required

Entity identifier

string format: uuid

"" >= 1 characters

name

required

Name of entity

string

"" >= 1 characters

rules

Optional rules for expiration date etc when agency is no longer managing this entity.

object

expires

Optional expiration date when agency is no longer managing this entity.

string format: date

nonExpired

Whether managing entity rules has expired.

boolean

numBookings

Optional total number of bookings [left] the agency is entitled to commission. This number will decrement every time a booking is made with this agency involved.

integer format: int32

valid

Whether managing entity is eligible a commission.

boolean

managers

Array<object>

Users who can manage this entity and all sub-entities.

object

active

boolean

email

required

Email address of the managing entity team member.

string format: email

"" >= 1 characters

firstName

First name of the team member.

string

lastName

Last name of the team member.

string

name

string

owner

Account owner

boolean

phoneNumber

Phone number for contacting the team member.

string

"" /^\+?[1-9]\d{1,14}$/

profilePicture

Profile picture is available

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

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

secondaryEmail

Secondary/alternative email address for the team member.

string format: email

sectionGrants

Array<object>

Per-section access grants for object-level ACL

object

level

required

Access level (READ < WRITE < FULL); a higher level subsumes all lower ones

string

Allowed values: READ WRITE FULL

section

required

Functional area of the platform this grant applies to; ALL is a wildcard that covers every section

string

Allowed values: ALL ACCOUNT INVENTORY BOOKING MARKETING CONTENT ANALYTICS INTEGRATIONS MCP PAYMENT ACCOUNTING USER_ADMIN ADMIN

status

Invitation status: PENDING (invite sent, awaiting response), ACCEPTED (active team member).

string

Allowed values: PENDING ACCEPTED DEACTIVATED

userIdentifier

Unique identifier of the associated user (null until invitation is accepted).

string format: uuid

marketingOptinAllowed

Whether the managing entity has consented to have their logo and images used for Wink marketing.

boolean

name

required

Display name of the managing entity.

string

"" >= 1 characters

onlinePresence

Array<object>

Online presence of account.

object

audienceSize

The size of your audience.

integer format: int64

audiences

Array<string>

Allowed values: EVERYONE ADVENTURE BEACH BUSINESS CULTURAL_EXPERIENCE EDUCATION FAMILY FOOD_AND_CULINARY HIKING HISTORICAL_SITES HONEYMOON LUXURY MEDICAL_TOURISM MUSIC_AND_FESTIVALS NATURE_AND_WILDLIFE PHOTOGRAPHY PILGRIMAGE RELAXATION ROAD_TRIP ROMANCE SHOPPING SKIING SOLO_TRAVEL SPORTS_EVENTS VOLUNTEERING WELLNESS_AND_SPA CITY WILDLIFE

disabled

Whether to disable this entry temporarily.

boolean

identifier

required

The url, account name or phone number that identifies this user with the specified network.

string

"" >= 1 characters

sort

How you would like to order your accounts.

integer format: int32

type

required

List of all active accounts that could be used for selling or seeing a company’s reach.

string

Allowed values: WINK WEB_SITE PERSONAL_WEB_SITE CORPORATE_WEB_SITE FACEBOOK INSTAGRAM TWITTER_X LINKEDIN TIKTOK SNAPCHAT MASTODON THREADS WEIBO HIVE_SOCIAL MEWE ELLO WHATSAPP TELEGRAM SIGNAL WECHAT LINE KAKAOTALK VIBER DISCORD SKYPE FACEBOOK_MESSENGER YOUTUBE TWITCH BILIBILI VIMEO DAILYMOTION KICK UPLIVE PINTEREST BEREAL VSCO IMGUR FLICKR FIVE_HUNDRED_PX REDDIT QUORA TUMBLR PLURK MEDIUM BLUESKY MINDS STEEMIT DIASPORA WHISPER YIK_YAK TELLONYM GOOGLE GITHUB SPOTIFY UPWORK SHOPIFY AMAZON PERSONAL_EMAIL WORK_EMAIL ONLY_FANS FANSLY

owner

A team member of a managing entity account, with their invitation/activation status, contact details, and per-section access grants.

object

active

boolean

email

required

Email address of the managing entity team member.

string format: email

"" >= 1 characters

firstName

First name of the team member.

string

lastName

Last name of the team member.

string

name

string

owner

Account owner

boolean

phoneNumber

Phone number for contacting the team member.

string

"" /^\+?[1-9]\d{1,14}$/

profilePicture

Profile picture is available

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

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

secondaryEmail

Secondary/alternative email address for the team member.

string format: email

sectionGrants

Array<object>

Per-section access grants for object-level ACL

object

level

required

Access level (READ < WRITE < FULL); a higher level subsumes all lower ones

string

Allowed values: READ WRITE FULL

section

required

Functional area of the platform this grant applies to; ALL is a wildcard that covers every section

string

Allowed values: ALL ACCOUNT INVENTORY BOOKING MARKETING CONTENT ANALYTICS INTEGRATIONS MCP PAYMENT ACCOUNTING USER_ADMIN ADMIN

status

Invitation status: PENDING (invite sent, awaiting response), ACCEPTED (active team member).

string

Allowed values: PENDING ACCEPTED DEACTIVATED

userIdentifier

Unique identifier of the associated user (null until invitation is accepted).

string format: uuid

ownerIdentifier

required

UUID of the application/owner that provisioned this record (typically Wink).

string format: uuid

"" >= 1 characters

ownerType

required

Owner type: INDIVIDUAL (sole proprietor) or COMPANY (corporate entity).

string

Allowed values: COMPANY INDIVIDUAL

placeId

Optional Google placeId for properties with a Google Business account.

string

profilePicture

Custom profile picture.

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

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

revolutPayoutAccounts

Array<object>

Revolut revtag payout destinations.

object

accountHolderName

required

Full legal name of the Revolut account holder (must match the Revolut profile name exactly).

string

"" >= 1 characters

currencyCode

required

ISO 4217 currency code for payouts to this account (e.g. EUR, USD, GBP).

string

"" >= 1 characters /^[A-Z]{3}$/

identifier

required

Unique identifier for this payout destination.

string format: uuid

"" >= 1 characters

profileType

required

Revolut profile type: PERSONAL (individual account) or BUSINESS (business/enterprise account).

string

Allowed values: personal business

revolutCounterpartyId

Cached Revolut counterparty ID (assigned after first successful payout). Null only during initial creation before counterparty is established.

string | null

revtag

required

Revolut username/tag (without the leading ‘@’ symbol).

string

"" >= 1 characters

status

required

Status of entity.

string

Allowed values: PENDING_APPROVAL ACTIVE INACTIVE UNDER_REVIEW SUSPENDED REJECTED REMOVED

travelAgent

Travel agent details.

object

selfAcquires

required

Whether the agent is in charge of charging the property.

boolean

selfDisburses

required

Whether the agent is in charge of paying the property.

boolean

type

required

Entity type: HOTEL, APPLICATION, TRAVEL_AGENT, INFLUENCER, CORPORATE, DESTINATION, CHANNEL_MANAGER, etc.

string

Allowed values: TRIP_PAY FACILITATOR DIRECT APPLICATION HOTEL TRAVELIKO CORPORATE TRAVEL_AGENT INFLUENCER BLOGGER DESTINATION CHANNEL_MANAGER PROPERTY_MANAGEMENT_SYSTEM CENTRAL_RESERVATION_SYSTEM GOOGLE_HOTEL_API MANAGEMENT_COMPANY CHAIN BRAND EVENT_ORGANIZER OTHER

uniqueId

required

Human-friendly unique identifier (shorter than UUID, used in some public contexts).

string

"" >= 1 characters

url

Primary website or social media URL representing the entity.

string format: uri

urlName

required

URL-friendly slug (kebab-case) uniquely identifying the entity in public profiles and links.

string

"" >= 1 characters

userIdentifier

required

UUID of the user who created/owns this managing entity.

string format: uuid

"" >= 1 characters

verified

boolean

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

key

additional properties

Example

{
  "accountEmail": "[email protected]",
  "currencyCode": "THB",
  "id": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
  "name": "The Siam Residences, Bangkok",
  "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
  "ownerType": "COMPANY",
  "status": "ACTIVE",
  "type": "HOTEL",
  "uniqueId": "siam-residences-bkk",
  "urlName": "the-siam-residences-bangkok",
  "userIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69"
}

400

Bad Request — missing or invalid request parameter or body

application/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

Unauthorized — authentication is required or the session has expired

application/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

Forbidden — authenticated but lacking the required permission or scope

application/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

Not Found — the requested resource does not exist

application/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

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

application/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

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

application/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

Unsupported Media Type — use application/json

application/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

Internal Server Error — an unexpected failure occurred on the server

application/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

Service Unavailable — a downstream dependency is unreachable

application/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

Add City

Authorizations

Parameters

Path Parameters

Example

Header Parameters

Request Bodyrequired

Example

Example

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

405

Example

409

Example

415

Example

500

Example

503

Example

Request Body^required