Create Transaction

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.lwolf.com/doc/zipform-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "ZipForm API MCP server": {
    "url": "https://apidocs.lwolf.com/doc/zipform-api/mcp"
  }
}
Close
POST /transactions
Context auth

Creates a new transaction for the authenticated user. name is required. data can include key-value pairs from the Transaction Data Keys appendix. transactionType and propertyType accept string or integer enum values.

application/json

Body Required

  • name string Required
  • status string
  • transactionType string

    Integer values: Listing=0, Purchase=1, Lease=2, LeaseListing=3

    Values are Listing, Purchase, Lease, or LeaseListing.

  • propertyType string

    Integer values: Residential=0, Commercial=1, Industrial=2, VacantLand=3, MultiUnit=4, FarmAndRanch=5, Condominium=6, ManufacturedHome=7, Coop=8, Unlisted=9

    Values are Residential, Commercial, Industrial, VacantLand, MultiUnit, FarmAndRanch, Condominium, ManufacturedHome, Coop, or Unlisted.

  • data object

    Key-value pairs of transaction data. See Transaction Data Keys in the introduction.

    Hide data attribute Show data attribute object
    • * string Additional properties

Responses

  • 201 application/json

    Transaction created successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Transaction GUID

    • name string
    • status string

      Values are active, pending, closed, inactive, or locked.

    • expiration string(date-time)
    • transactionType string

      Values are Listing, Purchase, Lease, or LeaseListing.

    • propertyType string

      Values are Residential, Commercial, Industrial, VacantLand, MultiUnit, FarmAndRanch, Condominium, ManufacturedHome, Coop, or Unlisted.

    • hasFiles boolean
    • created string(date-time)
    • lastUpdated string(date-time)
    • ownerName string
    • number integer
    • seller string
    • buyer string
    • propertyAddress string

      Full address in one value

    • address string
    • city string
    • state string
    • zip string
    • isSigned boolean

      Whether the transaction has signed documents

    • EncryptedOwnerId string(uuid)

      GUID of the agent who owns this transaction
  • 401

    Unauthorized

POST /transactions 
curl \
 --request POST 'https://ws.zipformplus.com/api/transactions' \
 --header "X-Auth-ContextId: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"123 Main Street","status":"active","transactionType":"Listing","propertyType":"Residential","data":{"additionalProperty1":"string","additionalProperty2":"string"}}'
Request examples 
{
  "name": "123 Main Street",
  "status": "active",
  "transactionType": "Listing",
  "propertyType": "Residential",
  "data": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}
Response examples (201) 
{
  "id": "string",
  "name": "1060 Mountain St",
  "status": "active",
  "expiration": "2026-05-04T09:42:00Z",
  "transactionType": "Listing",
  "propertyType": "Residential",
  "hasFiles": true,
  "created": "2026-05-04T09:42:00Z",
  "lastUpdated": "2026-05-04T09:42:00Z",
  "ownerName": "string",
  "number": 1033771,
  "seller": "string",
  "buyer": "string",
  "propertyAddress": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "isSigned": true,
  "EncryptedOwnerId": "string"
}