Skip to main content
POST
/
api
/
applications
Create application
curl --request POST \
  --url https://your-instance.example.com/api/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "64b2c3d4e5f60012345678aa",
  "name": "Maple Court — Unit 412",
  "pipelineStage": "New lead",
  "pipelineId": "64a1b2c3d4e5f6001234567a",
  "userId": "64a1b2c3d4e5f60012345679"
}
'
{
  "success": true,
  "message": "Application created successfully",
  "data": {
    "_id": "64d2f9c5e8a1d4e001a0b1c2",
    "name": "Maple Court — Unit 412",
    "organizationId": "64a1b2c3d4e5f60012345678",
    "status": "in_progress",
    "pipelineStage": "Tour scheduled",
    "createdAt": "2026-04-12T14:22:10.000Z",
    "updatedAt": "2026-04-12T14:22:10.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Either status or pipelineStage should be provided.

​
contactId
string
required

Contact _id this Application belongs to.

​
name
string
required

Display name for the Application (e.g. property/unit label).

​
status
string

Initial status label; mutually exchangeable with pipelineStage (one of the two must be provided).

​
pipelineStage
string

Stage _id within the chosen pipeline.

​
pipelineId
string

Pipeline _id this Application is tracked under.

​
userId
string

Owning user _id; defaults to the authenticated caller when omitted.

Response

Application created

Returned by POST /api/applications and PUT /api/applications/{id} — wraps the created/updated ApplicationDocument plus a status message.

​
success
enum<boolean>
required
Available options:
true
​
message
string
required
​
data
object
required

An Application document. Populated fields (contactId, userId) may be either an ObjectId string or a partial subset of the related document.

Example:
{
  "_id": "64d2f9c5e8a1d4e001a0b1c2",
  "name": "Maple Court — Unit 412",
  "organizationId": "64a1b2c3d4e5f60012345678",
  "contactId": {
    "_id": "64b2c3d4e5f60012345678aa",
    "firstName": "Alex",
    "lastName": "Nguyen",
    "phoneNumber": "+14155551234",
    "email": "alex.nguyen@example.com"
  },
  "userId": {
    "_id": "64a1b2c3d4e5f60012345679",
    "fullName": "Jordan Lee",
    "email": "jordan@maplegroup.example"
  },
  "status": "in_progress",
  "pipelineId": "64a1b2c3d4e5f6001234567a",
  "pipelineStage": "Tour scheduled",
  "createdAt": "2026-04-12T14:22:10.000Z",
  "updatedAt": "2026-04-22T10:14:00.000Z"
}