Create a customer request

POST/api/v2/workspaces/{slug}/customers/{customer_id}/requests/

Customer requests record what a customer asked for and link each request to work items. Create a customer request.

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.

customer_id:requiredstring (uuid)

The customer the resource belongs to.

Body parameters

name:requiredstring

Display name.

Maximum 255 characters.

description:optionalstring

Free-form description.

Nullable.

description_html:optionalstring

Rich-text body as HTML. The Plane editor reads and writes this field.

Nullable.

link:optionalstring

A URL for the request.

Nullable.

work_item_ids:optionalarray of string (uuid)

Ids of the work items to link to this request. Each linked work item also counts as linked to the customer. Ids of work items outside the workspace, archived work items, and work items you can't see are skipped without an error, so compare the work_item_ids in the response with what you sent.

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, created_at, created_by_id, customer_id, description, description_html, id, link, name, updated_at, updated_by_id, work_item_ids.

Scopes

customers.requests: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.

Create a customer request

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/requests/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example name",
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "link": "https://example.com",
  "work_item_ids": ["8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13"]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/requests/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Example name",
        "description": "What this is for.",
        "description_html": "<p>Details go here.</p>",
        "link": "https://example.com",
        "work_item_ids": ["8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13"],
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/requests/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example name",
      description: "What this is for.",
      description_html: "<p>Details go here.</p>",
      link: "https://example.com",
      work_item_ids: ["8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13"],
    }),
  },
);
const data = await response.json();

Response201

{
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "customer_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
  "name": "Example name",
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "link": "https://example.com",
  "work_item_ids": ["8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13"],
  "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
}