PUT
/
api
/
v1
/
integration-definition
/
{provider}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Hostaway Integration",
  "provider": "HOSTAWAY",
  "icon": "https://example.com/icons/hostaway.png",
  "partnerKey": {
    "headers": {
      "x-api-key": "YOUR_API_KEY"
    },
    "queryParams": {
      "client_id": "YOUR_CLIENT_ID"
    }
  },
  "fieldsToSync": {
    "listing": {
      "name": true,
      "type": true,
      "rooms": true,
      "rating": true,
      "address": true,
      "checkIn": false,
      "contact": false,
      "checkOut": false,
      "currency": true,
      "latitude": true,
      "pictures": false,
      "timeZone": false,
      "amenities": true,
      "longitude": true,
      "providerID": true,
      "startPrice": false,
      "description": true,
      "bedroomCount": false,
      "internalName": false,
      "maxOccupancy": false,
      "thumbnailUrl": false,
      "bathroomCount": false,
      "maximumNights": true,
      "minimumNights": true,
      "listingDetails": true,
      "parentPropertyID": false
    }
  },
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-02T00:00:00.000Z"
}

Authorizations

x-calry-api-key
string
header
required

Path Parameters

provider
enum<string>
required

The integration provider

Available options:
BOOKINGSYNC,
GUESTY,
HOSTAWAY,
HOSTFULLY,
HOSTIFY,
INTERHOME,
LODGIFY,
OWNERREZ,
HOSTHUB,
UPLISTING

Body

application/json

Response

200
application/json

Integration definition updated successfully

The response is of type object.