/deals/:id

Update a deal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

Deals Custom Fields

Any custom fields that have been created can also have their values updated via this method. For instance, if you had a custom field called "customField1", you could pass that in as an argument with an associated value in the body parameters for the POST request.

You can see how this would appear with multiple custom fields in the sample response object.

🚧

Empty userIds Argument

Sending a request with an empty userIds argument will create a deal that no agents can see. This may be intentional, depending on your use case, but note that agents will not be able to access the deal unless their user ID is explicitly included. Admins and owners can still see all deals.

Path Params
int32
required

The id of the deal.

Body Params
string

Name of the deal.

int32

The stage that this deal should be assigned to.

string

Description of the deal.

peopleIds
array of int32s

A list of person ids that should be part of this deal.

peopleIds
userIds
array of int32s

A list of user ids that should be part of this deal.

userIds
int32

The price associated with this deal.

date

Projected close date of this deal.

int32

Commission value to assign to this deal.

int32

Commission value for an agent split.

int32

Commission value for a team split.

date

Earnest Money Due Date for this deal.

date

Mutual Acceptance Date for this deal.

date

Due Diligence Date for this deal.

date

Final Walk Through Date for this deal.

date

Possession Date for this deal.

Responses

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