Projects update
Edit any field of a project.
PATCH/api/v1/projects/{id}
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
name | body | Project name. |
identifier | body | Short key for work item numbers, 2 to 10 capitals or digits (ACME); derived from the name when left out. |
description | body | What the project is. |
client_name | body | Client it is for. |
status | body | planned, active, paused, completed or cancelled. One of planned, active, paused, completed, cancelled. |
lead_id | body | The lead it came from. |
owner_id | body | Owner, a workspace member; the creator by default. |
start_date | body | YYYY-MM-DD. |
target_date | body | YYYY-MM-DD. |
Example
curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/projects/{id}" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"identifier": "",
"description": "",
"client_name": "",
"status": "planned",
"lead_id": "",
"owner_id": "",
"start_date": "",
"target_date": ""
}'CLI
sales-engine projects update <id>The JSON above lists every documented field with a typed placeholder; send only the ones you mean.
Response
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
requiredThe record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
PATCH /api/v1/projects/%7Bid%7D
Fill the path first.