Create an intake work item
Intake work items are the triage queue for a project. Create an intake work item.
Path parameters
slug:requiredstringThe workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.
project_id:requiredstringThe project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.
Body parameters
description_html:optionalstringRich-text body as HTML. The Plane editor reads and writes this field.
duplicate_to_id:optionalstring (uuid)Id of the work item this one is a duplicate of.
Nullable.
external_id:optionalstringYour system's identifier for this record, for sync and import correlation.
Nullable.
external_source:optionalstringThe system external_id came from, for example github or jira.
Nullable.
name:optionalstringDisplay name.
priority:optionalstringUrgency of the work item. One of none, low, medium, high, urgent.
snoozed_till:optionalstring (date-time)The time until which the intake work item is snoozed.
Nullable.
source:optionalstringWhere the intake work item came from.
source_email:optionalstringThe source email address.
Nullable.
status:optionalintegerTriage status. One of -2 (pending), -1 (rejected), 0 (snoozed), 1 (accepted), or 2 (duplicate).
Response shaping
fields:optionalstringComma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 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, updated_at, updated_by_id, work_item_id.
Scopes
projects.intakes:write
Errors
| Status | Code | Cause |
|---|---|---|
400 | invalid_request | The request body or a query parameter failed validation. |
401 | unauthorized | Missing or invalid credentials. |
402 | payment_required | The feature this endpoint belongs to isn't enabled on your plan or is switched off. |
403 | forbidden | Your role or token scope doesn't allow this. |
404 | not_found | No such resource, or it's outside your tenant. |
406 | not_acceptable | The Accept header asks for a representation the API can't produce. |
409 | conflict | A business rule blocks the write. |
413 | payload_too_large | The request body is over the size limit. |
415 | unsupported_media_type | The Content-Type isn't one this endpoint accepts. |
429 | rate_limited | Throttled. Honor the Retry-After header before retrying. |
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
}'import requests
response = requests.post(
"https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/intake-issues/",
headers={"X-Api-Key": "your-api-key"},
json={
"description_html": "<p>Details go here.</p>",
"duplicate_to_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
"external_id": None
},
)
print(response.json())const response = await fetch(
"https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/intake-issues/",
{
method: "POST",
headers: {
"X-Api-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
description_html: "<p>Details go here.</p>",
duplicate_to_id: "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
external_id: null,
}),
},
);
const data = await response.json();{
"created_at": "2026-01-14T09:22:41.478363Z",
"updated_at": "2026-01-14T09:22:41.478363Z",
"created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
"updated_by_id": null,
"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"
}
