Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 24 additions & 28 deletions docs/api-reference/customer/add-customer-property.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Create a customer property via Plane API. HTTP POST request format,
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Create a customer property

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -195,33 +194,30 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/",
{
method: "POST",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "example-name",
"display_name": "example-display_name",
"description": "example-description",
"property_type": "example-property_type",
"relation_type": "example-relation_type",
"is_required": true,
"is_multi": true,
"is_active": true,
"sort_order": 1,
"default_value": "example-default_value",
"settings": "example-settings",
"validation_rules": "example-validation_rules",
"logo_props": "example-logo_props",
"external_source": "example-external_source",
"external_id": "example-external_id"
})
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/", {
method: "POST",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "example-name",
display_name: "example-display_name",
description: "example-description",
property_type: "example-property_type",
relation_type: "example-relation_type",
is_required: true,
is_multi: true,
is_active: true,
sort_order: 1,
default_value: "example-default_value",
settings: "example-settings",
validation_rules: "example-validation_rules",
logo_props: "example-logo_props",
external_source: "example-external_source",
external_id: "example-external_id",
}),
});
const data = await response.json();
```

Expand Down
26 changes: 11 additions & 15 deletions docs/api-reference/customer/add-customer-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Create a customer request via Plane API. HTTP POST request format,
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Create a customer request

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -97,20 +96,17 @@ print(response.json())
<template #javascript>

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

Expand Down
26 changes: 11 additions & 15 deletions docs/api-reference/customer/add-customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Create a customer via Plane API. HTTP POST request format, required
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Create a customer

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -91,20 +90,17 @@ print(response.json())
<template #javascript>

```javascript
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 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();
```

Expand Down
16 changes: 6 additions & 10 deletions docs/api-reference/customer/delete-customer-property.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Delete a customer property via Plane API. HTTP DELETE request for r
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Delete a customer property

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -67,15 +66,12 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/",
{
method: "DELETE",
headers: {
"X-API-Key": "your-api-key"
}
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/", {
method: "DELETE",
headers: {
"X-API-Key": "your-api-key",
},
});
const data = await response.json();
```

Expand Down
5 changes: 2 additions & 3 deletions docs/api-reference/customer/delete-customer-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Delete a customer request via Plane API. HTTP DELETE request for re
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Delete a customer request

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -78,8 +77,8 @@ const response = await fetch(
{
method: "DELETE",
headers: {
"X-API-Key": "your-api-key"
}
"X-API-Key": "your-api-key",
},
}
);
const data = await response.json();
Expand Down
16 changes: 6 additions & 10 deletions docs/api-reference/customer/delete-customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Delete a customer via Plane API. HTTP DELETE request for removing r
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Delete a customer

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -67,15 +66,12 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/",
{
method: "DELETE",
headers: {
"X-API-Key": "your-api-key"
}
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/", {
method: "DELETE",
headers: {
"X-API-Key": "your-api-key",
},
});
const data = await response.json();
```

Expand Down
16 changes: 6 additions & 10 deletions docs/api-reference/customer/get-customer-detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Get retrieve a customer details via Plane API. Retrieve complete in
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Retrieve a customer

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -67,15 +66,12 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/",
{
method: "GET",
headers: {
"X-API-Key": "your-api-key"
}
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/", {
method: "GET",
headers: {
"X-API-Key": "your-api-key",
},
});
const data = await response.json();
```

Expand Down
16 changes: 6 additions & 10 deletions docs/api-reference/customer/get-customer-property-detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Get retrieve a customer property details via Plane API. Retrieve co
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Retrieve a customer property

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -67,15 +66,12 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/",
{
method: "GET",
headers: {
"X-API-Key": "your-api-key"
}
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/", {
method: "GET",
headers: {
"X-API-Key": "your-api-key",
},
});
const data = await response.json();
```

Expand Down
5 changes: 2 additions & 3 deletions docs/api-reference/customer/get-customer-property-value.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: List retrieve a customer property value via Plane API. HTTP GET req
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Retrieve a customer property value

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -78,8 +77,8 @@ const response = await fetch(
{
method: "GET",
headers: {
"X-API-Key": "your-api-key"
}
"X-API-Key": "your-api-key",
},
}
);
const data = await response.json();
Expand Down
5 changes: 2 additions & 3 deletions docs/api-reference/customer/get-customer-request-detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Get retrieve a customer request details via Plane API. Retrieve com
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# Retrieve a customer request

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -78,8 +77,8 @@ const response = await fetch(
{
method: "GET",
headers: {
"X-API-Key": "your-api-key"
}
"X-API-Key": "your-api-key",
},
}
);
const data = await response.json();
Expand Down
7 changes: 3 additions & 4 deletions docs/api-reference/customer/link-work-items-to-customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Link work items to customer API endpoint. Request format, parameter
keywords: plane, plane api, rest api, api integration, work items, issues, tasks, customers, crm, customer management
---


# Link work items to customer

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -95,11 +94,11 @@ const response = await fetch(
method: "POST",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json"
"Content-Type": "application/json",
},
body: JSON.stringify({
"issue_ids": "example-issue_ids"
})
issue_ids: "example-issue_ids",
}),
}
);
const data = await response.json();
Expand Down
16 changes: 6 additions & 10 deletions docs/api-reference/customer/list-customer-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: List all customer properties via Plane API. HTTP GET request with p
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# List all customer properties

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -88,15 +87,12 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/",
{
method: "GET",
headers: {
"X-API-Key": "your-api-key"
}
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/", {
method: "GET",
headers: {
"X-API-Key": "your-api-key",
},
});
const data = await response.json();
```

Expand Down
5 changes: 2 additions & 3 deletions docs/api-reference/customer/list-customer-property-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: List all customer property values via Plane API. HTTP GET request w
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---


# List all customer property values

<div class="api-endpoint-badge">
Expand Down Expand Up @@ -111,8 +110,8 @@ const response = await fetch(
{
method: "GET",
headers: {
"X-API-Key": "your-api-key"
}
"X-API-Key": "your-api-key",
},
}
);
const data = await response.json();
Expand Down
Loading
Loading