add-customer.md

title	Create a customer
description	Create a customer via Plane API. HTTP POST request format, required fields, and example responses.
keywords	plane, plane api, rest api, api integration, customers, crm, customer management

Create a customer

POST /api/v1/workspaces/{workspace_slug}/customers/

Creates a new customer in a workspace.

Path Parameters

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

Body Parameters

Name of the customer.

Email address of the customer.

Scopes

customers:write

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/customers/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "email": "example-email"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/customers/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'email': 'example-email'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/customers/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "email": "example-email"
})
  }
);
const data = await response.json();

{
  "id": "resource-uuid",
  "created_at": "2024-01-01T00:00:00Z"
}