Project

edit a project

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

See Project for a list of attributes which are supported for projects. Only attributes marked as Read-Write can be set using this endpoint. The only required attribute is name.

Path Params
int32
required

The identifier of the project.

Body Params
string

Name of the Project

string

Category name

keywords

List of Keywords Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

extra_fields
object

Each extra field will use its default name even if you have customized it

string
Defaults to new_status

The current status of the project. Project States

date

Due date of the project. Example: 2025-03-31T12:11:45.000Z

date

Start date of the project. Example: 2025-03-05T12:12:24.956Z

date

End date of the project. Example: 2025-03-31T12:11:00.000Z

string

Details of the opportunity

int32

Priority of the opportunity. Must be an integer value between 0 (lowest priority) and 10 (highest priority)

int32

Estimated time in minutes

contacts

List of Contact Roles Example: /v1/contacts/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

List of Company Roles Example: /v1/companies/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

appointments

List of Appointments Example: /v1/appointments/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

List of Forms Example: /v1/forms/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

List of Notes Example: /v1/notes/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

List of Tasks Example: /v1/tasks/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

List of Groups Example: /v1/groups/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

string

URL of the User Example: /v1/users/1000

boolean

You can use this to untrash an object by setting it to false. true will do nothing, use delete for that.

Responses

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