LOlofty
Lead Transaction

Update Transaction

Partially updates an existing transaction. Only supplied fields are applied; omitted fields remain unchanged. transactionStatus is writable: supply the stage's display name exactly as it appears in the team's transaction pipeline for the given transactionType (case-insensitive, e.g. "Under Contract"). A status name that matches no stage in that pipeline is rejected (200125); omit the field to keep the current status.

put/v1.0/leads/{leadId}/transaction/{transactionId}

Request

Path parameters

leadIdinteger required

Lead ID. Must be manageable by the caller.

transactionIdinteger required

Transaction ID. Must exist and be bound to leadId.

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

createdinteger

Transaction creation timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create.

updatedinteger

Transaction last-modified timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create or update.

transactionIdinteger

Transaction ID. Do not supply on create.

transactionNamestring required

Property address or deal name. Required on create. Must not be blank and must not contain '<' or '>' characters.

leadNamestring

Name of the lead this transaction belongs to. Ignored if supplied in a request body.

assignedAgentinteger

User ID of the agent this transaction is assigned to. Ignored if supplied in a request body.

transactionType'Purchase' | 'Listing' | 'Lease' | 'Other'

Transaction type. Case-sensitive; must be one of the supported values. Values not matching the team's configured pipeline types fall back silently to the first pipeline (typically 'Purchase / Pre-contract'); always pass a valid type to avoid this silent behavior.

homePricenumber

Home price of the transaction.

transactionStatusstring

Transaction status name. Must match one of the statuses configured in the team's pipeline for the given transactionType; unmatched values silently fall back to the first status of that type.

expectedCloseDateinteger

Expected close date, in milliseconds since Unix epoch (UTC).

closeDateinteger

Actual close date, in milliseconds since Unix epoch (UTC).

commissionRatenumber

Commission rate, expressed as a percentage (e.g. 3 for 3%).

gcinumber

Gross Commission Income (GCI) of the transaction.

teamRevenuenumber

Portion of the GCI attributed to the team.

agentRevenuenumber

Portion of the GCI attributed to the agent.

appointmentDateinteger

Appointment date, in milliseconds since Unix epoch (UTC).

agreementSignedDateinteger

Agreement-signed date, in milliseconds since Unix epoch (UTC).

offerDateinteger

Offer date, in milliseconds since Unix epoch (UTC).

contractDateinteger

Contract date, in milliseconds since Unix epoch (UTC).

appraisalDateinteger

Appraisal date, in milliseconds since Unix epoch (UTC).

homeInspectionDateinteger

Home-inspection date, in milliseconds since Unix epoch (UTC).

escrowDateinteger

Escrow date, in milliseconds since Unix epoch (UTC).

expirationinteger

Expiration date (listing / contract), in milliseconds since Unix epoch (UTC).

Example request

{
  "created": 1518078026000,
  "updated": 1518078026000,
  "transactionId": 10001,
  "transactionName": "123 Main St",
  "leadName": "Bob",
  "assignedAgent": 100001,
  "transactionType": "Purchase",
  "homePrice": 1000000,
  "transactionStatus": "Pre-contract",
  "expectedCloseDate": 1508580010000,
  "closeDate": 1508580010000,
  "commissionRate": 3,
  "gci": 5000,
  "teamRevenue": 1000,
  "agentRevenue": 4000,
  "appointmentDate": 1508580010000,
  "agreementSignedDate": 1508580010000,
  "offerDate": 1508580010000,
  "contractDate": 1508580010000,
  "appraisalDate": 1508580010000,
  "homeInspectionDate": 1508580010000,
  "escrowDate": 1508580010000,
  "expiration": 1508580010000
}

Response

Transaction updated. The response is the merged transaction.

createdinteger

Transaction creation timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create.

updatedinteger

Transaction last-modified timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create or update.

transactionIdinteger

Transaction ID. Do not supply on create.

transactionNamestring required

Property address or deal name. Required on create. Must not be blank and must not contain '<' or '>' characters.

leadNamestring

Name of the lead this transaction belongs to. Ignored if supplied in a request body.

assignedAgentinteger

User ID of the agent this transaction is assigned to. Ignored if supplied in a request body.

transactionType'Purchase' | 'Listing' | 'Lease' | 'Other'

Transaction type. Case-sensitive; must be one of the supported values. Values not matching the team's configured pipeline types fall back silently to the first pipeline (typically 'Purchase / Pre-contract'); always pass a valid type to avoid this silent behavior.

homePricenumber

Home price of the transaction.

transactionStatusstring

Transaction status name. Must match one of the statuses configured in the team's pipeline for the given transactionType; unmatched values silently fall back to the first status of that type.

expectedCloseDateinteger

Expected close date, in milliseconds since Unix epoch (UTC).

closeDateinteger

Actual close date, in milliseconds since Unix epoch (UTC).

commissionRatenumber

Commission rate, expressed as a percentage (e.g. 3 for 3%).

gcinumber

Gross Commission Income (GCI) of the transaction.

teamRevenuenumber

Portion of the GCI attributed to the team.

agentRevenuenumber

Portion of the GCI attributed to the agent.

appointmentDateinteger

Appointment date, in milliseconds since Unix epoch (UTC).

agreementSignedDateinteger

Agreement-signed date, in milliseconds since Unix epoch (UTC).

offerDateinteger

Offer date, in milliseconds since Unix epoch (UTC).

contractDateinteger

Contract date, in milliseconds since Unix epoch (UTC).

appraisalDateinteger

Appraisal date, in milliseconds since Unix epoch (UTC).

homeInspectionDateinteger

Home-inspection date, in milliseconds since Unix epoch (UTC).

escrowDateinteger

Escrow date, in milliseconds since Unix epoch (UTC).

expirationinteger

Expiration date (listing / contract), in milliseconds since Unix epoch (UTC).

Example response

{
  "created": 1518078026000,
  "updated": 1518078026000,
  "transactionId": 10001,
  "transactionName": "123 Main St",
  "leadName": "Bob",
  "assignedAgent": 100001,
  "transactionType": "Purchase",
  "homePrice": 1000000,
  "transactionStatus": "Pre-contract",
  "expectedCloseDate": 1508580010000,
  "closeDate": 1508580010000,
  "commissionRate": 3,
  "gci": 5000,
  "teamRevenue": 1000,
  "agentRevenue": 4000,
  "appointmentDate": 1508580010000,
  "agreementSignedDate": 1508580010000,
  "offerDate": 1508580010000,
  "contractDate": 1508580010000,
  "appraisalDate": 1508580010000,
  "homeInspectionDate": 1508580010000,
  "escrowDate": 1508580010000,
  "expiration": 1508580010000
}

Changes

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