Create Property

This endpoint enables partners to create a new property by submitting essential details such as the property name, category, physical location, check-in and check-out times, and other relevant attributes. On successful request processing, the API returns unique property ID for the newly created property.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/property/create

Header

app-id: c2l0****20=
Authorization: Basic M0****W0

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 alphanumeric (Required)

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

position object

Object containing geographical coordinates of the property.

latitude double (Required)

Latitude coordinates of the hotel location.

longitude double (Required)

Longitude coordinates of the hotel location.

check_in object (Optional)

Object containing check-in time.

from enumerated string (Optional)

Start time for check-in. Specify 24-hour check-in by using 00:00.

check_out object (Optional)

Object containing check-out time.

from enumerated string (Optional)

Start time for check-out. Specify 24-hour check-out by using 00:00.

property_name string (Required)

Name of the hotel property on Agoda.

property_category integer (Required)

Category identifier for the hotel. Must be a valid Agoda hotel category code.

description string (Optional)

Detailed description of the property.

room_count integer (Required for vacation rentals)

Number of rooms/units available for rent.

rental_license string (Required for vacation rentals)

Official rental license number.

stars string (Optional)

Hotel rating (0–5, in increments of 0.5).

currency_code enumerated string (Required)

Agoda-defined currency code (e.g., USD, NZD).

physical_address object (Required)

Object containing address details.

city_name string (Required)

City where the hotel is located.

country_code enumerated string (Required)

ISO country code (e.g., NZ for New Zealand).

postal_code string (Required)

Postal code of the hotel's location.

address_line string (Required)

Detailed address (max 255 characters).

images object (Required)

Object containing property images. Minimum 3 images required.

url 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 url, imageid, or pms_imageid must be provided.

is_primary boolean (Required)

Must have exactly one primary image.

tags array (Optional)

Image caption code. Only 1 tag allowed per image.

facilities array of objects (Required)

Object containing property facilities.

facility_id integer (Required)

Unique facility ID.

is_available boolean (Required)

Indicates availability.

contacts object (Required)

Object containing contact information.

contact_person object (Required)

name string (Required)

Contact person's first name.

last_name string (Required)

Contact person's last name.

phones object (Required)

phone_number string (Required)

Contact phone number.

email string (Required)

Contact email address.

property_settings object (Optional)

Object containing property-specific settings.

age_restriction object (Optional)

min_guest_age integer (Optional)

Minimum age required for guests.

max_infant_age integer (Optional)

Maximum age for infants.

children_policies object (Optional)

max_age integer (Optional)

Maximum age for children.

extra_bed_required_from_age integer (Optional)

Age from which extra bed is required.

child_stay_free boolean (Optional)

Indicates if children can stay for free.

child_stay_free_typeid integer (Optional)

Type ID for child stay free policy.

1: All children stay free (ignores max occupancy) 2: Limit based on max occupancy, others charged

policy_rules object (Optional)

Object Containing child policy rules.

from_age integer (Required)

Starting age for the rule.

to_age integer (Required)

Ending age for the rule.

rule_description string (Optional)

Description of the policy rule.

cancel_penalty array of objects (Optional)

Object containing cancellation policy details.

policy_code string (Required)

start_date string (Optional)

Start date for the policy. Format: YYYY-MM-DD.

end_date string (Optional)

End date for the policy. Format: YYYY-MM-DD.

fee_policies array of objects (Optional)

Object containing additional fee policies (recommended for vacation rentals).

policy_code string (Required)

Fee policy code.

amount string (Required)

Fee amount.

tax_policies array of objects (Optional)

Object containing additional tax policies (recommended for vacation rentals).

policy_code string (Required)

Tax policy code.

amount string (Required)

Tax amount.

start_date string (Optional)

Effective start date. Format: YYYY-MM-DD.

end_date string (Optional)

Expiration date. Format: YYYY-MM-DD.

local_recommendations array of objects (Optional)

Object containing local area recommendations (recommended for vacation rentals).

description string (Required)

Description of the recommendation.

house_rules array of objects (Optional)

Object containing property house rules (recommended for vacation rentals).

description string (Required)

Description of the house rule.

directions array of objects (Optional)

Object containing directions to the property (recommended for vacation rentals).

description string (Required)

Description of the direction.

Sample Request

{
    "hotel_id": "AWSTEST",
    "position": {
        "latitude": -11.636096,
        "longitude": 43.331237
    },
    "check_in": {
        "from": "12:30"
    },
    "check_out": {
        "from": "10:00"
    },
    "property_name": "AWS Test Property",
    "property_category": 30,
    "description": "property Description",
    "room_count":5,
    "rental_license":"12343",
    "stars": "4",
    "currency_code": "NZD",
    "physical_address": {
        "city_name": "Test City",
        "country_code": "KM",
        "postal_code": "0698",
        "address_line": "123 Queen Street"
    },
    "images":[
        {
            "is_primary": true,
            "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
            "tags": "2"
        },
        {
            "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
            "tags": "4"
        },
        {
            "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
            "tags": "4"
        }
    ],
    "facilities": [
        {
            "facility_id": "5",
            "is_available": true
        },
        {
            "facility_id": "7",
            "is_available": true
        },
        {
            "facility_id": "761",
            "is_available": true
        }
    ],
    "contacts": {
        "contact_person": {
            "name": "Bensen",
            "last_name": "Clay"
        },
        "phones": {
            "phone_number": "+31243611111"
        },
        "email": "tests@booking.com"
    },
    "property_settings": {
       "age_restriction": {
           "min_guest_age": 18,
           "max_infant_age": 2 
       },
       "children_policies": {
            "child_stay_free": true,
            "child_stay_free_typeid":1, 
            "max_age": 0,
            "policy_rules": [
                {
                    "from_age": 0,
                    "to_age": 5,
                    "rule_description": "Test Age Description"
                },
                {
                    "from_age": 6,
                    "to_age": 10,
                    "rule_description": "Test Age Description"
                }
            ]
        }
    },
    "cancel_penalty": [
        {
            "policy_code": "4447",
            "start_date": "2025-07-09",
            "end_date":"2026-07-09"
        },
        {
            "policy_code": "4459",
            "start_date": "2025-07-10"
        }
    ],
    "fee_policies": [
        {
            "policy_code": "76",
            "amount":"1000",
            "start_date": "2025-05-05",
            "end_date":"2026-06-05"
        },
        {
            "policy_code": "77",
            "amount":"1000",
            "start_date": "2025-05-05",
            "end_date":"2026-06-05"
        }
    ],
    "local_recommendations":[
        {
            "description": "Recommendations 1"
        },
        {
            "description": "Recommendations 1"
        }
    ],
    "house_rules":[
        {
            "description": "house_rules 1"
        },
        {
            "description": "house_rules 1"
        }
    ],
    "directions":[
        {
            "description": "directions 1"
        },
        {
            "description": "directions 1"
        }
    ],
    "tax_policies": [
            {
                "policy_code": "76",
                "amount": "1000",
                "start_date": "2025-05-05",
                "end_date": "2026-06-05"
            },
            {
                "policy_code": "77",
                "amount": "1000",
                "start_date": "2025-05-05",
                "end_date": "2026-06-05"
            }
        ]
}

Response

{
    "Status": "Success",
    "Data": {
        "channel_hotel_id": "78679219"
    },
    "Message": "Property created successfully",
    "Ruid": "610e3fcf-6ecd-11f0-a537-6d58688a4bbf"
}

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "599",
            "ShortText": "Property category is invalid or not found!"
        },
        {
            "Code": "511",
            "ShortText": "Images are required!"
        }
    ]
}

{
    "Status": "Fail",
    "Errors": [],
    "Message": "Invalid property category code",
    "Ruid": "610e3fcf-6ecd-11f0-a537-6d58688a4bbf"
}

Response Body Element

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

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

Data object

The response data, the root element.

Message string

The message in the response.

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.

PreviousAgoda Property API NextUpdate Property

Last updated 8 days ago

Was this helpful?