Customers

Create a customer

Create a customer record that work items and requests can be linked to.

post/workspaces/{workspace_slug}/customers/

Request

  • Base URL: https://api.plane.so/api/v1
  • URL: https://api.plane.so/api/v1/workspaces/{workspace_slug}/customers/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.plane.so/auth/o/authorize-app/, token URL https://api.plane.so/auth/o/token/; client credentials, token URL https://api.plane.so/auth/o/token/, scopes: customers:write)

Path parameters

workspace_slugstring required

Workspace identifier from the workspace URL. In https://app.plane.so/my-team/projects/ it is my-team.

Request body

namestring required
emailstring email
domainstring
website_urlstring uri
employeesinteger
stagestring
contract_statusstring
revenuestring
description_htmlstring
logo_propsobject

Response

The created customer.

idstring uuid required
namestring required
emailstring email nullable
domainstring nullable
website_urlstring uri nullable
employeesinteger nullable
stagestring nullable
contract_statusstring nullable
revenuestring nullable
description_htmlstring nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.