Sign in
Listings

Create listing

Creates a listing record. Required fields include agentGuid, checklistTypeId, property, listingDate, expirationDate, and listingPrice. If source is required for the subscriber, sourceId is required. If sourceId maps to Other Source, otherSource is also required. The listing is returned with status Incomplete until a seller contact (POST /api/files/listings/{listingGuid}/sellerContact) and commission data (POST /api/files/listings/{listingGuid}/commissions) are added; both are required for the listing to display as Active. See the Listings overview for the full creation workflow.

Validation & Requirements

Required Parameters

  • listingForm (body, object)

Required JSON Body Fields

  • agentGuid (format=guid, minLength=1)
  • checklistTypeId (format=int32)
  • expirationDate (format=date-time, minLength=1)
  • listingPrice (format=decimal)

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
post/api/files/listings

Request body

officeGuidstring guid nullable

Office guid that the Listing will be created in.

agentGuidstring guid required

The agent that this Listing is created for.

mlsNumberstring nullable
checklistTypeIdinteger required
sourceIdinteger nullable
otherSourcestring nullable
listingDatestring date-time nullable
isOfficeLeadboolean nullable
expirationDatestring date-time required
listingPricenumber required
coListingAgentGuidstring guid nullable
fileIDstring nullable
representationTypestring nullable

Optional representation type — which side the agent represents. Allowed values: Listing, Lease Landlord. Case-insensitive; omit to leave it unset (readers treat an unset value as Listing).

Response

warningsstring[] nullable

Changes

Changed in 1 of the 3 revisions of this API.1