ProjectsOperation projects.create

Projects create

Create a project with the default board (Backlog, Todo, In progress, Review, Done, Cancelled).

POST/api/v1/projects

Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Body

A JSON object, required. Fields not listed are ignored.

Name	In	Description
`name`required	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 POST "https://crm.ashwanth.dev/api/v1/projects" \
  -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 create --name "..."

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.

API 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.

Body (JSON)

Every documented field is listed above; leave out the ones you do not need.

Request

POST /api/v1/projects