Create Image

Creates one or more images for a listing in VRBO.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/image/create 

app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type: application/json
Header
Type
Required
Description

app-id

string

Yes

Your application ID. Required for authentication.

Authorization

string

Yes

Your API key for authorization. Required for authentication.

Content-Type

string

Yes

Must be set to application/json.


Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.


listing_id integer (Required)

VRBO listing ID where the image will be added.


images array (Required)

Array of image objects to add.


url string (Required)

URL of the image to upload.


tags array (Required)

Optional array of localized tags for the image.


locale string (Required)

Locale code for the tag.


value string (Required)

Tag value for the image.


Request

{
  "hotel_id": "AWSTEST",
  "listing_id": 73384756,
  "images": [
    {
      "url": "https://suissusit.otaswitch.com/images/fe99a2a569a7030a320d9e9958a4c212.jpg",
      "tags": [
        {
          "locale": "it-IT",
          "value": "API - U - 1"
        }
      ]
    }
  ]
}

Response

Success Response

{
  "Status": "Success",
  "Data": {
    "images": [
      {
        "id": "3476ea84-75c0-4a6c-b75d-2ab6db680d46",
        "image_url": "https://static.otaswitch.com/images/ceb4c47b2f5206340f34ae94b576ea75.jpeg",
        "tags": [],
        "show_first": true,
        "order": 1
      }
    ]
  },
  "Message": "Image create successfully",
  "Trace-ID": ""
}

Success Response - Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.


Data object

The response data, the root element.


images array (Required)

Array of the images.


id string

Unique identifier of the created image.


image_url string

URL of the uploaded image.


tags array

List of tags associated with the image.


show_first boolean

Indicates if this image will be displayed first.


order integer

Order of the image in the listing.


Message string

The message in the response.


Trace-ID string

Unique ID for tracing the API request.


Error Response

{
  "Status": "Fail",
  "Errors": [
    {
      "Code": "400",
      "ShortText": "hotel_id: Invalid HotelCode (:hotelid)"
    },
    {
      "Code": "2004",
      "ShortText": "Listing Id is required"
    },
    {
      "Code": "1391",
      "ShortText": "image_ids is invalid or not found!"
    }
  ],
  "Message": "",
  "Trace-ID": ""
}

Error Response - Body Elements

Status string

Indicates the result of the API call.

Will be always "Fail" in case of an error response.


Errors object

The response error, the root element.


Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.


ShortText string

A short description of the error.


Message string

The message in the response.


Trace-ID string

Unique ID for tracing the API request.

Last updated

Was this helpful?