Transactions

Update a transaction

Applies a partial update to a transaction. Only the fields present in the body are modified.

patch/transact-workflow/v1/users/{userId}/transactions/{transactionId}

Request

  • Base URL: https://api.lwolf.com
  • URL: https://api.lwolf.com/transact-workflow/v1/users/{userId}/transactions/{transactionId}
  • Auth: HTTP bearer and API key in header lw-subscription-key

Path parameters

userIdstring uuid required

Unique identifier (GUID) of the acting user. All Transact Workflow resources are scoped to a user.

transactionIdstring uuid required

GUID of the transaction.

Request body

typeinteger

Transaction type code. Observed value: 1. TODO: document the full list of code values and their meanings.

address1string

Property street address, line 1.

address2string

Property street address, line 2.

address3string

Property street address, line 3 (e.g. unit number).

address4string

Property street address, line 4.

localitystring

City / locality.

regionstring

State or province code.

subRegionstring

County or sub-region.

postalCodestring

Postal / ZIP code.

countrystring

Country.

legalDescriptionstring

Legal description of the property.

propertyIncludesstring

Items included with the property.

propertyExcludesstring

Items excluded from the property.

taxNumberstring

Property tax number.

mlsNumberstring

MLS listing number.

notestring

Free-form note.

schoolDistrictstring

School district.

zoningClassstring

Zoning classification.

yearBuiltinteger

Year the property was built.

phaseinteger

Transaction phase code. Observed value: 1. TODO: document the full list of code values and their meanings.

propertyTypeinteger

Property type code. Observed value: 0. TODO: document the full list of code values and their meanings.

askingnumber

Asking price.

depositnumber

Deposit amount.

taxesnumber

Annual taxes.

closingDatestring date-time

Closing date.

listingExpirationstring date-time

Listing expiration date.

listingGoesLivestring date-time

Date the listing goes live.

Example request

{
  "type": 1,
  "region": "ON",
  "yearBuilt": 1980,
  "phase": 1,
  "asking": 250000,
  "deposit": 10000,
  "taxes": 5000
}

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.