Create a customer request

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

Create a new request for the specified customer.

Path Parameters

customer_id:requiredstring

Customer id.

slug:requiredstring

Slug.

Body Parameters

name:requiredstring

Name.

description:optionalobject

Description.

description_html:optionalstring

Description html.

link:optionalstring

Link.

work_item_ids:optionalarray

Work item ids.

Scopes

customers.requests:write

Create a customer request

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Name",
  "description": "example-value",
  "description_html": "<p>Example content</p>",
  "link": "https://example.com/resource",
  "work_item_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "name": "Example Name",
      "description": "example-value",
      "description_html": "<p>Example content</p>",
      "link": "https://example.com/resource",
      "work_item_ids": [
"550e8400-e29b-41d4-a716-446655440000"
      ]
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example Name",
      description: "example-value",
      description_html: "<p>Example content</p>",
      link: "https://example.com/resource",
      work_item_ids: ["550e8400-e29b-41d4-a716-446655440000"],
    }),
  }
);
const data = await response.json();

Response201

{
  "name": "Example Name",
  "description": "example-value",
  "description_html": "<p>Example content</p>",
  "description_stripped": "Example description",
  "email": "Example Name",
  "website_url": "https://example.com/resource",
  "logo_props": "example-value",
  "domain": "Example Name",
  "employees": 1,
  "stage": "Example Name",
  "contract_status": "Example Name",
  "revenue": "Example Name",
  "archived_at": "2024-01-01T00:00:00Z",
  "created_by": "550e8400-e29b-41d4-a716-446655440000",
  "updated_by": "550e8400-e29b-41d4-a716-446655440000",
  "logo_asset": "550e8400-e29b-41d4-a716-446655440000"
}