latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Listing Documents

Add document

Adds a PDF document to the listing. fileName and base64Content are required.

Validation & Requirements

Required Parameters

  • listingGuid (path, string, format=guid)
  • form (body, object)

Required JSON Body Fields

  • base64Content (minLength=1)
  • fileName (minLength=1)

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.
  • File name is required and cannot exceed 150 characters.
  • base64Content must be valid base64.

Integration Requirement

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

Path parameters

listingGuidstring guid required

GUID of the listing you want to add the document to.

Request body

base64Contentstring required

The PDF as base64 encoded.

fileNamestring required

The filename of the pdf, it must include the .pdf extension.

Response

warningsstring[] nullable