Skip to content

Commit

Permalink
Clean-up
Browse files Browse the repository at this point in the history
  • Loading branch information
mattvagni committed Nov 20, 2023
1 parent 5a8df00 commit 24b0b0f
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 6 deletions.
3 changes: 2 additions & 1 deletion docs/api-reference/customer-cards.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: 'Customer Cards'
sidebarTitle: 'Overview'
description: 'Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers.'
---

Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers.

## How it works

1. A customer is viewed in Plain.
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/customer-cards/documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: 'Customer Cards Documentation'
description: 'This page is intended for a technical audience that will be implementing a Customer Card API.'
---

This page is intended for a technical audience that will be implementing a Customer Card API.

Check out the [Customer Cards](/pages/customer-cards) page for an overview.

## Protocol overview
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/graphql/error-codes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Error codes'
description: 'If you receive an error code as part of an API call, this is where you can look up what it means:'
description: 'If you receive an error code as part of an API call, this is where you can look up what it means'
---

#### `input_validation`
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/graphql/labels.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: 'Labels'
sidebarTitle: 'Overview'
description: 'Labels are a light-weight but powerful way to categorise threads, consisting of label text coupled with an icon. Each thread can have multiple labels.'
---

Labels are a light-weight but powerful way to categorise threads, consisting of label text coupled with an icon. Each thread can have multiple labels.

They can be added manually or programatically. For example when a contact form is submitted, you could automatically add a label to the corresponding thread with the issue category they selected, so that you know upfront why they are getting in touch.

The available labels you can apply are defined by your label types. Label types can be created and managed in your settings (**⌘ + K** and then search for "Manage labels").
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/graphql/labels/add.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: 'Add labels'
description: 'You can add multiple labels to a thread with a call to `addLabels`. Label type IDs passed to this endpoint should not be archived, we return a validation error with code `cannot_add_label_using_archived_label_type` for any which are submitted.'
---

You can add multiple labels to a thread with a call to `addLabels`. Label type IDs passed to this endpoint should not be archived, we return a validation error with code `cannot_add_label_using_archived_label_type` for any which are submitted.

If a label type you provide is already added to the thread we will return a validation error with code `label_with_given_type_already_added_to_thread`.

You can retrieve label type IDs in the Plain UI settings by hovering over a label type and selecting 'Copy label ID' from the overflow menu.
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/graphql/labels/remove.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: 'Remove labels'
description: 'You can remove labels from a thread with a call to `removeLabels`. Label IDs for this call can be retrieved by fetching a thread with the API.'
---

You can remove labels from a thread with a call to `removeLabels`. Label IDs for this call can be retrieved by fetching a thread with the API.

This operation requires the following permissions:

- `label:delete`
Expand Down

0 comments on commit 24b0b0f

Please sign in to comment.