Link or unlink customer work items

POST/api/v2/workspaces/{slug}/customers/{pk}/work-items/

Customers are the workspace CRM records you attach requests and work items to.

This is the write half of the route. To read the work items linked to the customer, send a GET to the same path, as described in List a customer's work items.

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.

pk:requiredstring (uuid)

The customer work item id.

Body Parameters

add:optionalarray of string (uuid)

The add.

remove:optionalarray of string (uuid)

The remove.

Scopes

customers: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 — see the notes above.
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.

Link or unlink customer work items

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "add": [
    "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
  ],
  "remove": [
    "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
  ]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "add": [
            "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
        ],
        "remove": [
            "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
        ]
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      add: ["f960d3c2-8524-4a41-b8eb-055ce4be2a7f"],
      remove: ["f960d3c2-8524-4a41-b8eb-055ce4be2a7f"],
    }),
  },
);
const data = await response.json();

Response200

{
  "added": ["f960d3c2-8524-4a41-b8eb-055ce4be2a7f"],
  "removed": ["f960d3c2-8524-4a41-b8eb-055ce4be2a7f"]
}