Upsert a module

POST/api/v2/workspaces/{slug}/projects/{project_id}/modules/upsert/

Modules group work items into a deliverable inside a project. Create a module, or update the existing one that carries the same (external_source, external_id) pair.

• Both external_source and external_id are required. Without them there is nothing to match on, and the request returns 400.
• A created record returns 201 with X-Plane-Upsert: created, and an updated one returns 200 with X-Plane-Upsert: updated. Branch on the header instead of guessing from the status.
• Upsert is safe for sequential importers. Two simultaneous upserts of the same key can each miss and each create, so serialize your writes per key.

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

name:requiredstring

Display name.

Maximum 255 characters.

description:optionalstring

Free-form description.

external_id:optionalstring

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

Maximum 255 characters. Nullable.

external_source:optionalstring

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

Maximum 255 characters. Nullable.

lead_id:optionalstring (uuid)

Id of the module's lead.

Nullable.

logo_props:optionalstring

Logo descriptor managed by the Plane editor. Send back the value you read instead of building it by hand.

sort_order:optionalnumber

Manual ordering weight. Lower sorts first.

start_date:optionalstring (date)

Planned start date, as YYYY-MM-DD.

Nullable.

status:optionalstring

• backlog - Backlog
• planned - Planned
• in-progress - In Progress
• paused - Paused
• completed - Completed
• cancelled - Cancelled

One of backlog, planned, in-progress, paused, completed, cancelled.

target_date:optionalstring (date)

Planned due date, as YYYY-MM-DD.

Nullable.

Response shaping

fields:optionalstring

Comma-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: archived_at, backlog_issues, cancelled_issues, completed_issues, created_at, created_by_id, description, description_html, external_id, external_source, id, lead_id, logo_props, member_ids, name, sort_order, start_date, started_issues, status, target_date, total_issues, unstarted_issues, updated_at, updated_by_id.

expand:optionalstring

Comma-separated relations to embed: lead, members.

Expanded objects get their own key: ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= work independently. Naming a relation in ?fields= returns 400, and field filtering never removes an expanded object. See Expanding relations.

Scopes

projects.modules: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.

Upsert a module

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/modules/upsert/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Billing revamp",
  "description": "Rework subscription billing end to end.",
  "start_date": "2026-01-05",
  "target_date": "2026-02-27",
  "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "external_id": "EPIC-311",
  "external_source": "jira"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/modules/upsert/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Billing revamp",
        "description": "Rework subscription billing end to end.",
        "start_date": "2026-01-05",
        "target_date": "2026-02-27",
        "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
        "external_id": "EPIC-311",
        "external_source": "jira",
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/modules/upsert/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Billing revamp",
      description: "Rework subscription billing end to end.",
      start_date: "2026-01-05",
      target_date: "2026-02-27",
      lead_id: "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      external_id: "EPIC-311",
      external_source: "jira",
    }),
  },
);
const data = await response.json();

Response201

{
  "id": "7c1f3d90-2a64-4e58-9b0d-3fa1c7e28b45",
  "name": "Billing revamp",
  "description": "Rework subscription billing end to end.",
  "description_html": null,
  "start_date": "2026-01-05",
  "target_date": "2026-02-27",
  "status": "planned",
  "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "member_ids": [],
  "sort_order": 65535.0,
  "external_id": "EPIC-311",
  "external_source": "jira",
  "logo_props": {},
  "total_issues": 0,
  "backlog_issues": 0,
  "unstarted_issues": 0,
  "started_issues": 0,
  "completed_issues": 0,
  "cancelled_issues": 0,
  "archived_at": null,
  "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
}