Publish Property API

This API is used to submit a landlord’s property for publication.

Note: The property will not be published immediately — it requires internal review and approval by the SCOM team before going live.

  • API: publishProperty

  • Purpose & Use Cases: Use this API to initiate the publishing process for a property. This is typically used when a landlord finishes setting up a property and is ready to request SCOM to review and activate the listing.

  • Request:

Attribute Name Data Type Required Details
propertyId DecodedPropertyID Yes The unique identifier of the related Property object 
  QUERY
mutation PublishProperty($input: PublishPropertyInput!) {
  publishProperty(input: $input) {
    success
  }
}

GRAPHQL VARIABLES
{
  "input": {
    "propertyId": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6MTA1Mjk2NX0"
  }
}
  • Response:
  {
    "data": {
        "publishProperty": {
            "success": true
        }
    }
}