CreatePropertyImage

  • API: createPropertyImage

  • Purpose & Use Cases: Create an image for the property.

  • Request:

Attribute Name Data Type Required Details
propertyId DecodedPropertyID Yes Identifier for the related property object
category ImageCategory Yes Category of the image; Possible values: BUILDING_EXTERIOR COMMON_INDOOR_SPACES COMMON_OUTDOOR_SPACES GENERAL ROOM SPECIFIC MAP
hero Boolean No Indicates if this image should be displayed as the main image
file Upload Yes The file to be uploaded 
  Method: Post
Body: Use Form-Data
Keys:
Operations: {
    "query": "mutation CreatePropertyImage($input:CreatePropertyImageInput!) {
        createPropertyImage(input: $input){
            image{\n active \n category \n hero \n filename \n id \n imageHash \n type \n status \n source}
        }
    }",
    "variables": {
        "input":{
            "file": null,
            "propertyId": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6MTA1NzcxNX0",
            "category": "ROOM",
            "hero": false
        }
    }
}
map: {"0":["variables.input.file"]}
0: upload your image

map: {
    "0": ["variables.input.file"]
}

0: upload your image
  • Response:
  {
    "data": {
        "createPropertyImage": {
            "image": {
                "active": false,
                "category": "ROOM",
                "hero": false,
                "filename": "1749624238930-Archways_ub_1-9f53e08e57542dfb41e02fde4f5b03ad",
                "id": "eyJ0eXBlIjoiSW1hZ2UiLCJpZCI6MzYzNTgyNX0=",
                "imageHash": "1809ab2724183626eb7a5255df18c17b",
                "type": "ROOM_IMAGE",
                "status": "EXTERNAL_NEW",
                "source": "1749624238930-Archways_ub_1-9f53e08e57542dfb41e02fde4f5b03ad-1809ab2724183626eb7a5255df18c17b.jpg"
            }
        }
    }
}
  • Error Message:
Error Message Description
input.propertyId is not exist Unable to perform bulk operations on floor plans because the specified propertyId does not exist

DeleteImage

  • API: deleteImage

  • Purpose & Use Cases: Delete an image associated with the property.

  • Request:

Attribute Name Data Type Required Details
id DecodedImageID Yes Identifier for the related image object 
  QUERY
mutation DeleteImage($input: DeleteImageInput!) {
    deleteImage(input: $input) {
        success
    }
}

GRAPHQL VARIABLES
{
  "input": {
    "id": "eyJ0eXBlIjoiSW1hZ2UiLCJpZCI6MTE1MjU1Mn0"
  }
}
  • Response:
  {
    "data": {
        "deleteImage": {
            "success": true
        }
    }
}

CreateRoomImage

  • API: createRoomImage

  • Purpose & Use Cases: Create an image for the room.

  • Request:

Attribute Name Data Type Required Details
roomId DecodedUnitTypeID Yes Identifier for the related room object
file Upload Yes The file to be uploaded 
  Method: Post
Body: Use Form-Data
Keys:
Operations: {
    "query": "mutation CreateRoomImage($input:CreateRoomImageInput!) {
        createRoomImage(input: $input){
            image{\n active \n category \n hero \n filename \n id \n imageHash \n type \n status \n source}
            }
        }",
    "variables": {
        "input": {
            "file": null,
            "roomId": "eyJ0eXBlIjoiVW5pdFR5cGUiLCJpZCI6MTAwOTkyOTd9="
        }
    }
}

map: {
    "0": ["variables.input.file"]
}

0: upload your image
  • Response:
  {
    "data": {
        "createRoomImage": {
            "image": {
                "active": false,
                "category": "ROOM",
                "hero": false,
                "filename": "1749710065762-49b8da4f-9037-4158-a869-65e92da1d736_1721728892756589130~tplv-a9rns2rl98-web-image",
                "id": "eyJ0eXBlIjoiSW1hZ2UiLCJpZCI6MzYzNzc2NH0=",
                "imageHash": "31b6b9d4b6417f541f3cbde398f6b46c",
                "type": "ROOM_IMAGE",
                "status": "EXTERNAL_NEW",
                "source": "1749710065762-49b8da4f-9037-4158-a869-65e92da1d736_1721728892756589130~tplv-a9rns2rl98-web-image-31b6b9d4b6417f541f3cbde398f6b46c.jpeg"
            }
        }
    }
}
  • Error Message:
Error Message Description
file type error Unable to upload a room image because the file type is not one of the following: (jpg JPG png PNG bmp BMP jpeg JPEG)

Image object

Attribute Name Data Type Details
id DecodedListingID Identifier for the image object
type ImageType The type of image; Possible values: PROPERTY_IMAGE ROOM_IMAGE FLOOR_PLAN_IMAGE
category ImageCategory Category of the image; Possible values: BUILDING_EXTERIOR COMMON_INDOOR_SPACES COMMON_OUTDOOR_SPACES GENERAL ROOM SPECIFIC MAP
imageHash String A unique identifier hash value representing the image file
source String The source of the image
filename String The filename of the image