Update Detailed Description

This endpoint updates the description details of an Airbnb listing including summary, space description, notes, rules, and other descriptive fields.

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 contains 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.


space string (Optional)

what makes it unique, and how many people does it comfortably fit.


summary string (Optional)

Should cover the major features of the space and neighborhood in 500 characters or less.


transit string (Optional)

Information on getting to the property. E.g. Is their convenient public transit? Is parking included with the listing or nearby? How does the guest get to the listing from the airport?


house_rules string (Optional)

Instructions for guests on how to behave. Should also include whether pets are allowed and if there are rules about smoking.


notes string (Optional)

Any additional details for the guest to know.


access string (Optional)

Information about what parts of the space the guests will be able to access.


neighborhood_overview string (Optional)

Information about the neighborhood and surrounding region. Suggestions about what guests should experience & do.


interaction string (Optional)

How much the Host will interact with the guests, and if the Host will be present during the guest stay.


Request


Response


Success Response


Success Response - Body Elements

Status string

Indicates the result of the API call. Will always be "Success" for successful operations.


Data object

Contains the updated listing description details.


listing_description object

Descriptive information of the listing after the update:


space string

Updated space description.


summary string

Updated summary of the listing.


transit string

Updated transit information.


description string

Main description text of the listing.


listing_id string

ID of the listing updated.


house_rules string

Updated house rules.


locale string

Language code of the description.


name string

Name of the listing.


notes string

Updated notes.


access string

Updated access information.


neighborhood_overview string

Updated neighborhood overview.


interaction string

Updated host interaction details.


Message string

Message confirming successful update of the listing description.


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?