Plain

App · 20 actions

Run your Plain support desk from workflows: open, label, assign, snooze, close and reply to threads, keep customers and accounts in step with your own systems, add notes and set account tiers.

Actions

ActionWhat it does
Add labels to threadPut one or more labels on a thread.
Add noteAdd an internal note to a customer, or to one of their threads.
Change thread statusMark a thread done or to do, or snooze it until a time.
Create or update accountAdd an account (a company you support), or update the one with this id of yours: its name and link.
Create or update customerAdd a customer, or update the one with this email address: their name, short name and your own id for them.
Create threadOpen a support thread for a customer, with a title, priority, labels and assignee.
Delete accountDelete an account.
Delete customerDelete a customer for good, with their threads and notes.
Delete threadDelete a thread for good, with its messages and notes.
Get customerFind one customer by email address, Plain id or your own external id.
Get threadGet one thread with its status, priority, customer, assignee, labels, account and tier.
List accountsList the accounts (companies) your customers belong to, by name, optionally only those in one tier.
List customersList customers by name, optionally only those changed since a time.
List labelsList the labels threads can be given in your workspace, with their ids and the group each is in.
List threadsList support threads, filtered by status, priority, customer, label or assignee.
List tiersList your support tiers, which set the SLAs and default priority of the threads of the accounts in them.
Remove labels from threadTake one or more labels off a thread.
Reply to threadSend the customer a reply on the thread's own channel (email, chat, Slack or Teams), as the connected machine user.
Set account tierPut an account in a support tier, in place of any tier it was in.
Update threadRename a thread, change its priority or assign it to a teammate.

Add labels to thread

Put one or more labels on a thread.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.
Labelslabel_type_idslistRequired
The labels to use. Pick one or more.

Outputs

labelslist
The labels added
threadobject
The thread
Example output
{
  "labels": [
    {
      "id": "l_01HXAMPLELABEL",
      "labelType": {
        "id": "lt_01HXBUG",
        "name": "Bug"
      }
    }
  ],
  "thread": {
    "account": {
      "id": "acc_01HXACME",
      "name": "Acme Inc"
    },
    "assignedTo": {
      "email": "sam@yourcompany.com",
      "fullName": "Sam Support",
      "id": "u_01HXAMPLEUSER",
      "type": "user"
    },
    "channel": "API",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "customer": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false
    },
    "description": "The export button does nothing.",
    "externalId": "ticket-77",
    "id": "th_01HXAMPLETHREAD",
    "labels": [
      {
        "id": "l_01HXAMPLELABEL",
        "labelType": {
          "id": "lt_01HXBUG",
          "name": "Bug"
        }
      }
    ],
    "previewText": "The export button does nothing.",
    "priority": 1,
    "priorityLabel": "High",
    "ref": "T-1042",
    "status": "TODO",
    "statusChangedAt": "2026-10-15T09:00:00.000Z",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "title": "Cannot export invoices",
    "updatedAt": "2026-10-15T09:05:00.000Z"
  }
}

Add note

Add an internal note to a customer, or to one of their threads. Only your team sees it.

Inputs

CustomercustomertextRequired
The customer's email address, Plain id (c_...) or your own external id for them.
NotetexttextRequired
The note. Markdown such as **bold** and links works.
Threadthread_idtext
Put the note on this thread of theirs (id or reference such as T-123). Leave empty to add it to the customer.

Outputs

noteobject
The note
Example output
{
  "note": {
    "createdAt": "2026-10-15T09:10:00.000Z",
    "customerId": "c_01HXAMPLECUSTOMER",
    "id": "n_01HXAMPLENOTE",
    "markdown": "Called them about the export bug.",
    "text": "Called them about the export bug.",
    "threadId": "th_01HXAMPLETHREAD"
  }
}

Change thread status

Mark a thread done or to do, or snooze it until a time. Any new message moves it back to to do.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.
StatusstatustextRequired
The thread's new status.One of: TODO (To do), SNOOZED, DONE.
Snooze untilsnooze_untildate and time
When the thread comes back to to do.Only when Status is Snoozed.

Outputs

threadobject
The thread
Example output
{
  "thread": {
    "account": {
      "id": "acc_01HXACME",
      "name": "Acme Inc"
    },
    "assignedTo": {
      "email": "sam@yourcompany.com",
      "fullName": "Sam Support",
      "id": "u_01HXAMPLEUSER",
      "type": "user"
    },
    "channel": "API",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "customer": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false
    },
    "description": "The export button does nothing.",
    "externalId": "ticket-77",
    "id": "th_01HXAMPLETHREAD",
    "labels": [
      {
        "id": "l_01HXAMPLELABEL",
        "labelType": {
          "id": "lt_01HXBUG",
          "name": "Bug"
        }
      }
    ],
    "previewText": "The export button does nothing.",
    "priority": 1,
    "priorityLabel": "High",
    "ref": "T-1042",
    "status": "DONE",
    "statusChangedAt": "2026-10-15T09:00:00.000Z",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "title": "Cannot export invoices",
    "updatedAt": "2026-10-15T09:05:00.000Z"
  }
}

Create or update account

Add an account (a company you support), or update the one with this id of yours: its name and link.

Inputs

Your id for itexternal_idtextRequired
The account's id in your own systems, which finds it if it exists.
NamenametextRequired
The account's name, such as the company name.
Linkurltext
A link to the account in your own product or admin.

Outputs

accountobject
The account
resulttext
CREATED, UPDATED or NOOP (nothing to change)
Example output
{
  "account": {
    "createdAt": "2026-10-01T09:00:00.000Z",
    "externalId": "acme",
    "id": "acc_01HXACME",
    "name": "Acme Inc",
    "primaryDomain": "acme.example.com",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "updatedAt": "2026-10-15T09:00:00.000Z",
    "url": "https://acme.example.com/admin"
  },
  "result": "CREATED"
}

Create or update customer

Add a customer, or update the one with this email address: their name, short name and your own id for them. Plain does not email them.

Inputs

EmailemailtextRequired
The customer's email address, which finds them if they exist.
Full namefull_nametextRequired
The customer's full name.
Short nameshort_nametext
What to call them, usually their first name.
Your id for themexternal_idtext
The customer's id in your own systems.
Accountaccount_idtext
The account (company) this belongs to in Plain.

Outputs

customerobject
The customer
resulttext
CREATED, UPDATED or NOOP (nothing to change)
Example output
{
  "customer": {
    "avatarUrl": "https://example.com/jo.png",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "email": "jo@example.com",
    "externalId": "cust-1001",
    "fullName": "Jo Bloggs",
    "id": "c_01HXAMPLECUSTOMER",
    "isEmailVerified": false,
    "markedAsSpamAt": "",
    "shortName": "Jo",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  },
  "result": "CREATED"
}

Create thread

Open a support thread for a customer, with a title, priority, labels and assignee. The customer is not messaged; use 'Reply to thread' to write to them.

Inputs

CustomercustomertextRequired
The customer's email address, Plain id (c_...) or your own external id for them.
TitletitletextRequired
What the thread is about.
Descriptiondescriptiontext
More detail, shown as the thread's preview in Plain.
Priorityprioritytext
How urgent the thread is. New threads are Normal unless set.One of: 0 (Urgent), 1 (High), 2 (Normal), 3 (Low).
Labelslabel_type_idslist
Labels to put on the thread.
Assign toassigned_to_user_idtext
The teammate to assign the thread to.
Accountaccount_idtext
The account (company) this belongs to in Plain.
Your id for itexternal_idtext
The thread's id in your own systems, such as a ticket number.

Outputs

threadobject
The thread
Example output
{
  "thread": {
    "account": {
      "id": "acc_01HXACME",
      "name": "Acme Inc"
    },
    "assignedTo": {
      "email": "sam@yourcompany.com",
      "fullName": "Sam Support",
      "id": "u_01HXAMPLEUSER",
      "type": "user"
    },
    "channel": "API",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "customer": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false
    },
    "description": "The export button does nothing.",
    "externalId": "ticket-77",
    "id": "th_01HXAMPLETHREAD",
    "labels": [
      {
        "id": "l_01HXAMPLELABEL",
        "labelType": {
          "id": "lt_01HXBUG",
          "name": "Bug"
        }
      }
    ],
    "previewText": "The export button does nothing.",
    "priority": 1,
    "priorityLabel": "High",
    "ref": "T-1042",
    "status": "TODO",
    "statusChangedAt": "2026-10-15T09:00:00.000Z",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "title": "Cannot export invoices",
    "updatedAt": "2026-10-15T09:05:00.000Z"
  }
}

Delete account

Delete an account. Its customers and threads stay, without it.

Inputs

Accountaccount_idtextRequired
The account (company) in Plain.

Outputs

account_idtext
The account deleted
deletedtrue/false
Always true once deleted
Example output
{
  "account_id": "acc_01HXACME",
  "deleted": true
}

Delete customer

Delete a customer for good, with their threads and notes.

Inputs

CustomercustomertextRequired
The customer's email address, Plain id (c_...) or your own external id for them.

Outputs

customer_idtext
The customer deleted
deletedtrue/false
Always true once deleted
Example output
{
  "customer_id": "c_01HXAMPLECUSTOMER",
  "deleted": true
}

Delete thread

Delete a thread for good, with its messages and notes.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
thread_idtext
The thread deleted
Example output
{
  "deleted": true,
  "thread_id": "th_01HXAMPLETHREAD"
}

Get customer

Find one customer by email address, Plain id or your own external id. Fails if there is none.

Inputs

CustomercustomertextRequired
The customer's email address, Plain id (c_...) or your own external id for them.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "avatarUrl": "https://example.com/jo.png",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "email": "jo@example.com",
    "externalId": "cust-1001",
    "fullName": "Jo Bloggs",
    "id": "c_01HXAMPLECUSTOMER",
    "isEmailVerified": false,
    "markedAsSpamAt": "",
    "shortName": "Jo",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  }
}

Get thread

Get one thread with its status, priority, customer, assignee, labels, account and tier.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.

Outputs

threadobject
The thread
Example output
{
  "thread": {
    "account": {
      "id": "acc_01HXACME",
      "name": "Acme Inc"
    },
    "assignedTo": {
      "email": "sam@yourcompany.com",
      "fullName": "Sam Support",
      "id": "u_01HXAMPLEUSER",
      "type": "user"
    },
    "channel": "API",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "customer": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false
    },
    "description": "The export button does nothing.",
    "externalId": "ticket-77",
    "id": "th_01HXAMPLETHREAD",
    "labels": [
      {
        "id": "l_01HXAMPLELABEL",
        "labelType": {
          "id": "lt_01HXBUG",
          "name": "Bug"
        }
      }
    ],
    "previewText": "The export button does nothing.",
    "priority": 1,
    "priorityLabel": "High",
    "ref": "T-1042",
    "status": "TODO",
    "statusChangedAt": "2026-10-15T09:00:00.000Z",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "title": "Cannot export invoices",
    "updatedAt": "2026-10-15T09:05:00.000Z"
  }
}

List accounts

List the accounts (companies) your customers belong to, by name, optionally only those in one tier. Gets one page; to see more, run it again with the next page it gives.

Inputs

Tiertier_idtext
Only accounts in this tier.
Page sizepage_sizenumber
How many to return, 1 to 100. Plain's default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

accountslist
The accounts
countnumber
How many are on this page
has_next_pagetrue/false
Whether more follow
next_cursortext
Give this as 'Next page cursor' to get the next page; empty on the last
Example output
{
  "accounts": [
    {
      "createdAt": "2026-10-01T09:00:00.000Z",
      "externalId": "acme",
      "id": "acc_01HXACME",
      "name": "Acme Inc",
      "primaryDomain": "acme.example.com",
      "tier": {
        "id": "tier_01HXGOLD",
        "name": "Gold"
      },
      "updatedAt": "2026-10-15T09:00:00.000Z",
      "url": "https://acme.example.com/admin"
    }
  ],
  "count": 1,
  "has_next_page": false,
  "next_cursor": ""
}

List customers

List customers by name, optionally only those changed since a time. Gets one page; to see more, run it again with the next page it gives.

Inputs

Changed sinceupdated_sincedate and time
Only customers created or changed since this time.
Page sizepage_sizenumber
How many to return, 1 to 100. Plain's default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are on this page
customerslist
The customers
has_next_pagetrue/false
Whether more follow
next_cursortext
Give this as 'Next page cursor' to get the next page; empty on the last
total_countnumber
How many match in all
Example output
{
  "count": 1,
  "customers": [
    {
      "avatarUrl": "https://example.com/jo.png",
      "createdAt": "2026-10-15T09:00:00.000Z",
      "email": "jo@example.com",
      "externalId": "cust-1001",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false,
      "markedAsSpamAt": "",
      "shortName": "Jo",
      "updatedAt": "2026-10-15T09:00:00.000Z"
    }
  ],
  "has_next_page": false,
  "next_cursor": "",
  "total_count": 1
}

List labels

List the labels threads can be given in your workspace, with their ids and the group each is in.

Inputs

Include archivedinclude_archivedtrue/false
Also list labels that have been archived.

Outputs

countnumber
How many
label_typeslist
The labels
Example output
{
  "count": 1,
  "label_types": [
    {
      "color": "#FF0000",
      "description": "Something is broken",
      "externalId": "bug",
      "id": "lt_01HXBUG",
      "isArchived": false,
      "name": "Bug",
      "parentLabelType": {
        "id": "lt_01HXPRODUCT",
        "name": "Product"
      }
    }
  ]
}

List threads

List support threads, filtered by status, priority, customer, label or assignee. Gets one page; to see more, run it again with the next page it gives.

Inputs

Statusstatuseslist
Only threads in these statuses. All when none is picked.One or more of: TODO (To do), SNOOZED, DONE.
Priorityprioritieslist
Only threads of these priorities. All when none is picked.One or more of: 0 (Urgent), 1 (High), 2 (Normal), 3 (Low).
Customercustomertext
Only this customer's threads: their email address, Plain id or your own id for them.
Labelslabel_type_idslist
Only threads with any of these labels.
Assigned toassigned_to_user_idtext
Only threads assigned to this teammate.
Ordersorttext
How to order the threads. Defaults to newest first.One of: newest (Newest first (default)), oldest (Oldest first), status_changed (Status changed most recently), priority (Most urgent first), last_message (Latest customer message first). Default: newest.
Page sizepage_sizenumber
How many to return, 1 to 100. Plain's default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are on this page
has_next_pagetrue/false
Whether more follow
next_cursortext
Give this as 'Next page cursor' to get the next page; empty on the last
threadslist
The threads
total_countnumber
How many match in all
Example output
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "threads": [
    {
      "account": {
        "id": "acc_01HXACME",
        "name": "Acme Inc"
      },
      "assignedTo": {
        "email": "sam@yourcompany.com",
        "fullName": "Sam Support",
        "id": "u_01HXAMPLEUSER",
        "type": "user"
      },
      "channel": "API",
      "createdAt": "2026-10-15T09:00:00.000Z",
      "customer": {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "c_01HXAMPLECUSTOMER",
        "isEmailVerified": false
      },
      "description": "The export button does nothing.",
      "externalId": "ticket-77",
      "id": "th_01HXAMPLETHREAD",
      "labels": [
        {
          "id": "l_01HXAMPLELABEL",
          "labelType": {
            "id": "lt_01HXBUG",
            "name": "Bug"
          }
        }
      ],
      "previewText": "The export button does nothing.",
      "priority": 1,
      "priorityLabel": "High",
      "ref": "T-1042",
      "status": "TODO",
      "statusChangedAt": "2026-10-15T09:00:00.000Z",
      "tier": {
        "id": "tier_01HXGOLD",
        "name": "Gold"
      },
      "title": "Cannot export invoices",
      "updatedAt": "2026-10-15T09:05:00.000Z"
    }
  ],
  "total_count": 1
}

List tiers

List your support tiers, which set the SLAs and default priority of the threads of the accounts in them.

Inputs

None.

Outputs

countnumber
How many
tierslist
The tiers
Example output
{
  "count": 1,
  "tiers": [
    {
      "color": "#FABADA",
      "defaultThreadPriority": 1,
      "externalId": "gold",
      "id": "tier_01HXGOLD",
      "isDefault": false,
      "name": "Gold"
    }
  ]
}

Remove labels from thread

Take one or more labels off a thread. Labels the thread doesn't have are skipped.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.
Labelslabel_type_idslistRequired
The labels to use. Pick one or more.

Outputs

removed_countnumber
How many were removed
threadobject
The thread
Example output
{
  "removed_count": 1,
  "thread": {
    "account": {
      "id": "acc_01HXACME",
      "name": "Acme Inc"
    },
    "assignedTo": {
      "email": "sam@yourcompany.com",
      "fullName": "Sam Support",
      "id": "u_01HXAMPLEUSER",
      "type": "user"
    },
    "channel": "API",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "customer": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false
    },
    "description": "The export button does nothing.",
    "externalId": "ticket-77",
    "id": "th_01HXAMPLETHREAD",
    "labels": [],
    "previewText": "The export button does nothing.",
    "priority": 1,
    "priorityLabel": "High",
    "ref": "T-1042",
    "status": "TODO",
    "statusChangedAt": "2026-10-15T09:00:00.000Z",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "title": "Cannot export invoices",
    "updatedAt": "2026-10-15T09:05:00.000Z"
  }
}

Reply to thread

Send the customer a reply on the thread's own channel (email, chat, Slack or Teams), as the connected machine user. The customer receives it.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.
MessagemessagetextRequired
The reply. Markdown such as **bold** and links works.

Outputs

senttrue/false
Always true once sent
thread_idtext
The thread replied to
Example output
{
  "sent": true,
  "thread_id": "th_01HXAMPLETHREAD"
}

Set account tier

Put an account in a support tier, in place of any tier it was in.

Inputs

Accountaccount_idtextRequired
The account (company) in Plain.
Tiertier_idtextRequired
The tier to put the account in.

Outputs

account_idtext
The account
membership_idtext
The id of the account's place in the tier
tier_idtext
The tier it is now in
Example output
{
  "account_id": "acc_01HXACME",
  "membership_id": "tm_01HXAMPLE",
  "tier_id": "tier_01HXGOLD"
}

Update thread

Rename a thread, change its priority or assign it to a teammate. Empty fields are left as they are.

Inputs

Threadthread_idtextRequired
The thread's id (th_...) or its reference such as T-123, from 'List threads' or an earlier step.
Titletitletext
A new title. Leave empty to keep it.
Priorityprioritytext
A new priority. Leave empty to keep it.One of: 0 (Urgent), 1 (High), 2 (Normal), 3 (Low).
Assign toassigned_to_user_idtext
The teammate to assign it to. Leave empty to keep the assignee.

Outputs

threadobject
The thread
Example output
{
  "thread": {
    "account": {
      "id": "acc_01HXACME",
      "name": "Acme Inc"
    },
    "assignedTo": {
      "email": "sam@yourcompany.com",
      "fullName": "Sam Support",
      "id": "u_01HXAMPLEUSER",
      "type": "user"
    },
    "channel": "API",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "customer": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "c_01HXAMPLECUSTOMER",
      "isEmailVerified": false
    },
    "description": "The export button does nothing.",
    "externalId": "ticket-77",
    "id": "th_01HXAMPLETHREAD",
    "labels": [
      {
        "id": "l_01HXAMPLELABEL",
        "labelType": {
          "id": "lt_01HXBUG",
          "name": "Bug"
        }
      }
    ],
    "previewText": "The export button does nothing.",
    "priority": 1,
    "priorityLabel": "High",
    "ref": "T-1042",
    "status": "TODO",
    "statusChangedAt": "2026-10-15T09:00:00.000Z",
    "tier": {
      "id": "tier_01HXGOLD",
      "name": "Gold"
    },
    "title": "Cannot export invoices",
    "updatedAt": "2026-10-15T09:05:00.000Z"
  }
}

On this page