Delete Image
This endpoint allows you to permanently delete a specific photo associated with a property. Note that only one photo can be deleted per request.
You must provide the hotel_id, channel_hotel_id, and the photo_id to be deleted in the request body.
Endpoint
POST
Header
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.
channel_hotel_id string (Required)
The unique identifier of the hotel in the specified channel.
photo_id string (Required)
Specifies the unique photo ID of the photo you want to delete.
Sample Request
Response
Sample Success Response
Success Response Body Elements
Status string
Indicates the result of the API call.
Data object
The response data, the root element.
Message string
A message providing more information about the error.
Ruid string
Specifies the unique request ID.
Errors
Sample Error Response 1
Sample Error Response 2
Sample Error Response 3
Sample Error Response 4
Error Response Body Elements
Status string
Indicates the result of the API call, which will be always "Fail" in case of an error response.
Error array
Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Last updated
Was this helpful?