Skip to main content
POST
Create application

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: