Update a business

Updates the specific business by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Supply the unique business ID from either a business creation request or the business list.

Update a contact

PATCH https://api.treevox.com/v1/business/:id

Updates the specific business by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path Parameters

Name	Type	Description
id*	Number	The Id of the business to be update

Headers

Name	Type	Description
Content-Type*	application/json
Accept-Encoding	gzip
x-api-key*	String	your api key in treevox

Request Body

Property	Type	Description
title	String	Business Title
value	Number	Business Value
deadline	Date	Business Deadline
private	Boolean	Business Private
position	Number	Business Position
dateWon	Date	Business date when the business was marked as won.
reasonLost	String	Business reason for marking it as lost.
statusId	Number	Status ID of the business. Status ID has to be the identifier in treevox.
organizationId	Number	Organization ID of the Organization. Organization ID has to be the identifier in treevox.
currencyId	Number	Currency ID of the business. Currency ID has to be the identifier in treevox.
userOwnerId	Number	User Owener ID of the business. User Owener ID has to be the identifier in treevox.
userCreatorId	Number	User ID that created this contact. User ID has to be the identifier in treevox. If the User ID does not exist, an error will be returned.
boardId	Number	Board ID of the business. Board ID has to be the identifier in treevox.
stageId	Number	State ID of the business. State ID has to be the identifier in treevox.

200: OK Returns a business object if the call succeeded.

{
    "id": 1,
    "title": "New Website Project",
    "value": 15000,
    "deadline": "2025-12-31T23:59:59.000Z",
    "private": false,
    "position": 1,
    "dateWon": "2025-03-20T15:30:00.000Z",
    "reasonLost": null,
    "statusId": 2,
    "organizationId": 45,
    "currencyId": 1,
    "userOwnerId": 12,
    "userCreatorId": 8,
    "boardId": 3,
    "stageId": 7,
    "createdAt": "2025-01-10T10:15:30.000Z",
    "updatedAt": "2025-09-10T12:45:00.000Z"
}

400: Bad Request Returns error.

{
    "timestamp": "2021-11-25T03:45:20.986Z",
    "message": "Validation failed",
    "code": "bad_request",
    "errors": [
        {
            "property": "field",
            "validator": {
                "isDateString": "value not valid"
            }
        }
    ]
}

404: Not Found Returns error.

{
    "timestamp": "2021-11-25T03:45:20.986Z",
    "message": "Business not found",
    "code": "business_not_found"
}