Skip to content

Create an intake work item ​

POST/api/v2/workspaces/{slug}/projects/{project_id}/intake-issues/

Intake work items are the triage queue for a project. Create an intake work item.

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

Body Parameters ​

description_html:optionalstring

Rich-text body as HTML. This is the field the Plane editor round-trips.

duplicate_to_id:optionalstring (uuid)

Id of the related duplicate to.

Nullable.

external_id:optionalstring

Your system's identifier for this record, for sync and import correlation.

Nullable.

external_source:optionalstring

The system external_id came from, for example github or jira.

Nullable.

name:optionalstring

Display name.

priority:optionalstring
  • none - none
  • low - low
  • medium - medium
  • high - high
  • urgent - urgent

One of none, low, medium, high, urgent.

snoozed_till:optionalstring (date-time)

The snoozed till.

Nullable.

source:optionalstring

The source.

source_email:optionalstring

The source email.

Nullable.

status:optionalinteger

The status.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, created_by_id, description_html, duplicate_to_id, external_id, external_source, id, intake_id, name, priority, snoozed_till, source, source_email, state_id, status, work_item_id.

Scopes ​

projects.intakes:write

Errors ​

StatusCodeCause
400invalid_requestThe request body or a query parameter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan or is switched off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictA business rule blocks the write — see the notes above.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Create an intake work item
bash
curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/intake-issues/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description_html": "<p>Details go here.</p>",
  "duplicate_to_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "external_id": null
}'
Response201
json
{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "duplicate_to_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "intake_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "name": "Example name",
  "priority": "high",
  "snoozed_till": "2026-01-14T09:22:41.478363Z",
  "source": "example",
  "source_email": "example",
  "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "status": -2,
  "work_item_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}