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/identifiercontractTypeId: The contract type template to use
Optional Fields:
- Property information (address, value)
- Referral tracking
- People (
contactsor legacycontactIds/contactRoleIds; do not send both) - Buyer and seller representatives (
buyerRepresentativeUserId,sellerRepresentativeUserId; the same user may represent both sides) - Custom fields defined by the contract type
Write Validation:
Unsupported aliases (amount, close_date, address, property_address, person_id, people, and stage_id, including camelCase variants) return 422 before creating a contract. Use contractValue, scheduledClosingDate, the split propertyStreet/propertyUnit/propertyCity/propertyState/propertyZip fields, contactIds (an array of person IDs), and primaryPipelineStageId. Optional contactRoleIds must also be an array. Stage IDs must belong to the configured pipeline. Custom field keys (customXxx or customFields: { ... }) must name a field on the contract type, values must be single values, and dropdown values must be one of the field's choices (matched case-insensitively); otherwise the request returns 422 naming each rejected key and no contract is created.
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",
"contacts": [{ "personId": "person-uuid-1", "roleId": "role-uuid", "isPrimary": true }],
"buyerRepresentativeUserId": "user-uuid",
"sellerRepresentativeUserId": "user-uuid"
}| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
