Create a contract

Create a new contract in your team. Contracts track business deals through customizable pipelines with milestones and tasks.

Use Cases:

  • Create new real estate transactions
  • Track service agreements
  • Monitor project deals
  • Initialize contract workflows with milestones

Required Fields:

  • name: Contract name/identifier
  • contractTypeId: The contract type template to use

Optional Fields:

  • Property information (address, value)
  • Referral tracking
  • Contact associations
  • Custom fields defined by the contract type

Automatic Initialization:

  • Milestones defined in the contract type are automatically created
  • Tasks associated with milestones are auto-generated
  • Primary pipeline stage is set from the contract type

Example - Basic Contract:

{
  "name": "123 Main St Sale",
  "contractTypeId": "uuid-here",
  "assignedUserId": "uuid-here"
}

Example - Full Contract:

{
  "name": "456 Oak Ave Listing",
  "contractTypeId": "uuid-here",
  "assignedUserId": "uuid-here",
  "contractValue": 450000,
  "scheduledClosingDate": "2025-12-31",
  "homeInspectionDate": "2025-12-15",
  "totalCommission": 13500,
  "buyerCommission": 3,
  "buyerCommissionType": "percentage",
  "sellerCommission": 3,
  "sellerCommissionType": "percentage",
  "propertyStreet": "456 Oak Ave",
  "propertyCity": "Portland",
  "propertyState": "OR",
  "propertyZip": "97201",
  "referralSource": "Past Client",
  "contactIds": ["person-uuid-1", "person-uuid-2"]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Contract name (required)

uuid
required

Contract type ID (required)

uuid | null

Assign to specific user

date

Scheduled closing date

date

Home inspection date

date

Actual closing date

number

Contract value in dollars

number

Total commission in dollars

number

Buyer commission (percentage or dollar amount)

string
enum

Buyer commission type

Allowed:
number

Seller commission (percentage or dollar amount)

string
enum

Seller commission type

Allowed:
string

Property street address

string

Property unit/apt number

string

Property city

string

Property state (2-letter code)

string

Property ZIP code

string

How this contract was referred

uuid

Person who referred this contract

uuid

Company that referred this contract

contactIds
array of uuids

Person IDs to associate as contacts

contactIds
Responses
201

contract created

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json