Create Photo

This endpoint creates one or more photos for a specific Airbnb listing, including captions, sort order, category, and associated room or facility IDs.

Endpoint

POST


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


hotelid alphanumeric (Required)

Specifies the required node hotelid containing the IT provider's hotel ID for which the provider wishes to add mapping information.


channelhotelid alphanumeric (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).


listingid numeric (Required)

Listing ID of the property allocated by Airbnb.


images array of objects (Required)

Array containing image details to be uploaded.


caption string (Optional)

Caption for the image.


sort_order numeric (Optional)

Order of the image.


image string (Required)

URL of the image.


imageid string (Optional)

Unique identifier from the image API (su_imageid).


pms_imageid string (Optional)

PMS-assigned image ID (must exist in the SU system).

Note: At least one of image, imageid, or pms_imageid must be provided.


category enum (Required)

Short description of the photo. Allowed values: LISTING, ROOM, LISTING_AMENITY, ROOM_AMENITY.


facility_id numeric (Required only if category is LISTING_AMENITY or ROOM_AMENITY)

ID of the facility for which the image is uploaded.


room_id numeric (Required only if category is ROOM or ROOM_AMENITY)

ID of the Airbnb room for which the image is uploaded.


Request


Response


Success Response


Success Response - Body Elements

Status string

Indicates the result of the API call. Will be "Success" if the photos are created successfully.


Data array of objects

Contains details of each uploaded photo. Each object includes:


airbnb_photo_id string

The Airbnb-assigned ID of the uploaded photo.


message string

Status message indicating the photo was uploaded.


Message string

Response message indicating the overall result of the photo creation operation.


Error Response


Error Response - Body Elements

Status string

Indicates the result of the API call.

circle-info

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.

circle-info

For example: "400" indicates a bad request.


ShortText string

A short description of the error.


Message string

The message in the response.

Last updated

Was this helpful?