Skip to main content
Plain logo
  • Category: customer support
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 120
  • Triggers: 11
  • Slug: PLAIN
  • Version: 20261101_00

Tools

Slug: PLAIN_ADD_CUSTOMER_TO_GROUPAdd a customer to up to 25 customer groups. Existing memberships are skipped, and the response contains only newly created memberships.

Input Parameters

string
required
ID of the customer to add to groups.
array
required
One to 25 customer group identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_ADD_CUSTOMER_TO_TENANTSIdempotently add a customer to one or more tenants.

Input Parameters

array
required
One or more tenants to add or remove.
object
required
Customer whose memberships change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_ADD_GENERATED_REPLYAdd a suggested reply for teammate review without sending it to the customer.

Input Parameters

string
required
Suggested reply in Markdown, at most 5,000 characters.
string
required
Thread to add the suggestion to.
string
required
Most recent inbound customer or machine-user message to answer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_ADD_LABELSAdd one or more labels to a thread by label-type ID.

Input Parameters

string
required
Thread receiving labels.
array
required
Active label-type IDs to add.
boolean
Add only when the thread currently has no labels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_ADD_MEMBERS_TO_TIERAdd or move up to 25 tenants or companies into one tier.

Input Parameters

object
required
Tier receiving the members.
array
required
Tenants or companies to add or move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_ARCHIVE_LABEL_TYPEArchive a label type while preserving labels already on threads.

Input Parameters

string
required
Label-type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_BULK_DELETE_THREAD_FIELDSSequentially delete thread-field values by thread and schema key. Deletions are non-atomic; an interrupted call can leave earlier deletions committed without returning all item results.

Input Parameters

array
required
Thread and schema-key pairs whose values should be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_BULK_SET_THREAD_FIELDSCreate or replace multiple typed thread-field values.

Input Parameters

array
required
One to 25 thread-field values to create or replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CHANGE_THREAD_ASSIGNMENTAssign or unassign a thread’s primary assignee, or add or remove additional assignees. For AI-agent assignment, LIVE allows customer replies while SHADOW observes without sending customer replies.

Input Parameters

array
Additional human-user IDs.
object
Primary user or machine-user assignee for ASSIGN.
string
required
Thread to update.
string ("LIVE" | "SHADOW")
AI-agent assignment mode. LIVE allows the assigned agent to reply to customers; SHADOW observes real threads but sends no customer replies.
string ("ASSIGN" | "UNASSIGN" | "ADD_ADDITIONAL" | "REMOVE_ADDITIONAL")
required
Assignment transition to perform.
array
Additional machine-user IDs.
boolean
Assign only when no primary assignee exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_ATTACHMENT_DOWNLOAD_URLCreate a sensitive three-minute URL and return its virus-scan result. Download or process the file only when attachmentVirusScanResult is CLEAN. Treat INFECTED as unsafe, FAILED or PENDING as not cleared, and null as unscanned; do not fetch or expose the file in any of those states. Do not log or share the URL.

Input Parameters

string
required
Attachment whose temporary URL to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_ATTACHMENT_UPLOAD_FORMCreate a sensitive, two-hour presigned upload capability; no file is uploaded. Do not log or share uploadFormUrl or uploadFormData. Next, POST multipart/form-data directly to uploadFormUrl with every uploadFormData key/value as a form field and the exact binary file in the form field named file. After that upload succeeds, pass the returned attachment.id to a compatible message or note action.

Input Parameters

string
required
File name displayed by Plain.
string
required
Customer who owns the attachment.
integer
required
Exact file size in bytes.
string ("CHAT" | "CUSTOM_TIMELINE_ENTRY" | "DISCORD" | "EMAIL" | "MS_TEAMS" | "NOTE" | "SLACK" | "THREAD_DISCUSSION")
required
Destination channel, which determines Plain’s size limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_AUTORESPONDERCreate an autoresponder that automatically sends outbound customer replies. Enabled autoresponders can send irreversible external messages when new threads match. Plain permits at most 25 autoresponders per workspace and delays up to 900 seconds.

Input Parameters

string
required
Autoresponder name.
integer
required
Priority order from 0 through 99.
boolean
required
Whether it may fire.
array
required
Conditions that must all match.
string
required
Plain-text reply body.
array
required
Eligible inbound sources.
string
Markdown reply body.
integer
Delay before sending, from 0 (immediate) through 900 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_CUSTOMER_GROUPCreates a new customer group in Plain for organizing and segmenting customers. Customer groups allow you to categorize customers (e.g., by pricing tier, feature access, or support level) and manage them more effectively in your support workflow. Each group has a unique key, display name, and visual color for easy identification. Use this when you need to create a new customer segment for organization or filtering purposes.

Input Parameters

string
required
Unique identifier key for the customer group. Must be unique across all customer groups in your workspace. Use lowercase with underscores (e.g., ‘vip_customers’).
string
required
Display name of the customer group (e.g., ‘VIP Customers’, ‘Free Tier’). Used for organization and display purposes.
string
required
Hex color code for the group (e.g., #FF5733). Must be a valid 6-digit hex color starting with #.
string
Optional external ID to link this customer group with an identifier from your system (e.g., Stripe plan ID, internal database ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_DISCUSSIONImmediately and irreversibly start an external EMAIL or SLACK discussion. EMAIL delivers the first message to every emailDetails.toAddresses recipient and optional ccAddresses recipient. SLACK posts it to the connected channel selected by slackDetails.connectedSlackChannelId. Live provider authorization requires threadDiscussion:create, although the current operation page omits it.

Input Parameters

string ("EMAIL" | "SLACK")
required
Public discussion channel to use.
string
required
Thread to attach the side-conversation to.
object
Required only for EMAIL discussions.
object
Required only for SLACK discussions.
array
Previously uploaded THREAD_DISCUSSION attachment IDs.
string
required
First discussion message in Markdown.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_EVENTCreate a custom customer-wide or single-thread timeline event.

Input Parameters

string
required
Event title.
string ("CUSTOMER" | "THREAD")
required
Event owner type.
string
Thread ID for THREAD.
string
Optional backfilled ISO 8601 event timestamp.
array
required
Timeline event components.
string
Unique event external ID.
boolean
Render collapsed by default.
object
Customer selector for CUSTOMER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_LABEL_TYPECreate a label type that can be applied to threads.

Input Parameters

string
Label icon.
string
required
Label-type name.
string ("DEFAULT" | "TEAM")
Workspace-wide or team-scoped type.
string
Label color.
string
Unique external ID.
string
Label-type description.
boolean
Exclude from AI suggestions.
string
Parent label-type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_NOTECreate an internal note on an existing customer thread. Plain’s live API currently rejects customer-level notes without threadId even though the current GraphQL SDL marks that input nullable.

Input Parameters

string
required
Plain-text internal note body.
string
Optional Markdown version of the note body.
string
required
Thread whose timeline receives the note. The live API requires threadId even though the current GraphQL SDL marks it nullable.
string
required
Customer who owns the thread receiving the note.
array
IDs of previously uploaded NOTE attachments, at most 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_SERVICE_LEVEL_AGREEMENTCreate one legacy tier SLA; next-response requires a first-response SLA on the tier.

Input Parameters

string
required
Tier that will inherit this SLA.
object
required
SLA target and applicability configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_SERVICE_LEVEL_AGREEMENT_POLICYCreate a named SLA policy with zero or more unique target types.

Input Parameters

string
required
Policy display name.
array
required
Unique SLA targets for the policy.
string
Optional policy description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_SNIPPETCreate a reusable plain-text and optional Markdown reply snippet.

Input Parameters

string
required
Searchable snippet name.
string
Optional alphanumeric folder path in the Plain app.
string
required
Plain-text snippet body.
string
Optional rich Markdown version of the snippet body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_TASKCreate a task with optional company, tenant or account context and an optional assignee. Tenant and account IDs may be supplied together; a company ID cannot be combined with either.

Input Parameters

string
required
Task title.
string ("TODO" | "IN_PROGRESS" | "DONE" | "CANCELLED")
Initial task lifecycle status.
integer
Priority from 0 (highest) to 3 (lowest).
string
Optional parent tenant ID. On update, setting this clears any existing company parent; omitting it leaves the current parent unchanged.
string
Optional parent account ID.
string
Optional parent company ID. On update, setting this clears any existing tenant parent; omitting it leaves the current parent unchanged.
object
Optional user or machine-user assignee.
string
Optional task details or instructions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_THREADCreate a thread after obtaining a valid customer identifier. Creating a thread can trigger a configured autoresponder, which sends an external reply to the customer; that outbound message cannot be recalled.

Input Parameters

string
Optional title of the new thread
string ("EMAIL" | "SLACK" | "CHAT" | "API" | "MS_TEAMS" | "DISCORD" | "IMPORT" | "INTERNAL")
Thread channel; defaults to API. SLACK and MS_TEAMS require matching channelDetails
integer
Optional priority from 0 (most urgent) to 3 (least urgent); defaults to 2
object
Optional human-user or machine-user assignment for the thread
array
Optional list of content components for the thread
string
Optional unique thread identifier from your own system
string
Optional thread preview description; Plain infers it when omitted
array
Optional list of label type IDs to assign
array
Optional typed thread-field values to set on the new thread
array
Deprecated attachment IDs for the first timeline entry; prefer channel-specific send actions
object
Channel details required for SLACK or MS_TEAMS threads
object
Optional exact-one identifier for the tenant assigned to the thread
object
Optional exact-one account identifier assigned to the thread
object
required
Identifier object for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_THREAD_FIELD_SCHEMACreate a custom thread-field schema.

Input Parameters

string
required
Immutable lowercase field key.
string ("STRING" | "BOOL" | "ENUM" | "NUMBER" | "CURRENCY" | "DATE")
required
Stored field type.
string
required
Unique human-readable field name.
integer
required
Display order.
array
required
Allowed ENUM values; empty otherwise.
boolean
required
Whether Done requires a value.
string
required
Field description.
string
Default DATE value in ISO 8601 format.
boolean
Restrict writes to the API.
number
Default NUMBER or CURRENCY value.
string
Default STRING or ENUM value.
boolean
Default BOOL value.
boolean
required
Allow AI auto-fill.
boolean
Expose as agent context.
object
Conditional parent field.
array
Labels that reveal this field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_CREATE_TIERCreate a support tier, optionally assigning tenant or company members.

Input Parameters

string
required
Tier display name.
string
required
Six-digit hexadecimal tier color.
boolean
Whether unmatched threads use this tier.
string
required
Unique external tier ID.
array
Initial tenant and company members, up to 25.
integer
Default thread priority from 0 (urgent) to 3 (low).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_AUTORESPONDERPermanently delete a native autoresponder.

Input Parameters

string
required
Native autoresponder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_CUSTOMERPermanently and irreversibly deletes a Plain customer by ID, including all associated threads, timeline entries, and other customer data. Deletion runs asynchronously. Confirm the destructive operation before calling.

Input Parameters

string
required
Unique identifier of the customer to delete, as returned by the Plain API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_CUSTOMER_GROUPPermanently delete an empty customer group after confirmation.

Input Parameters

string
required
Plain ID of the customer group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_NOTESoft-delete an internal note.

Input Parameters

string
required
Note to soft-delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_SERVICE_LEVEL_AGREEMENTDelete a legacy SLA from a tier. A first-response SLA cannot be deleted while the tier still has a next-response SLA; delete the next-response SLA first.

Input Parameters

string
required
Plain ID of the legacy SLA to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_SERVICE_LEVEL_AGREEMENT_POLICYDelete an SLA policy, its targets, and their trackers. Threads using the deleted policy fall back to their tier’s SLAs.

Input Parameters

string
required
Plain SLA policy ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_SNIPPETSoft-delete a snippet while preserving historical references.

Input Parameters

string
required
Snippet to soft-delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_TASKSoft-delete a task and remove its thread links.

Input Parameters

string
required
Plain task ID to soft-delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_TENANTDelete a tenant, unlink its customers, and remove its field values. Existing threads retain a reference to the tenant deletion record but are no longer routed through that tenant.

Input Parameters

object
required
Tenant to delete. The operation unlinks its customers and removes its field values; existing threads retain a deletion-record reference but are no longer routed through the tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_TENANT_FIELDClear one tenant field value without deleting its schema.

Input Parameters

string
required
Plain ID of the tenant-field value to clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_TENANT_FIELD_SCHEMAPermanently delete a tenant-field schema and all values stored against it.

Input Parameters

string
required
Plain ID of the tenant-field schema to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_THREADPermanently delete a thread and all associated data.

Input Parameters

string
required
Plain thread ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_THREAD_FIELD_SCHEMADelete a schema and all values stored against it.

Input Parameters

string
required
Thread-field schema ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_TIERPermanently delete a tier and all of its memberships. The live API also requires serviceLevelAgreementBreachAction:delete, including when the tier does not exist. Plain’s API-key UI grantability for that permission is currently unknown.

Input Parameters

string
required
Plain tier ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_DELETE_USERPermanently removes a Plain workspace user by ID. Their threads remain but become unassigned. Plain rejects deletion when the user is the workspace’s only owner, so assign another owner first. Confirm this destructive operation.

Input Parameters

string
required
Unique identifier of the user to delete, as returned by the Plain API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_ESCALATE_OR_SELECT_PATHAdvance a thread’s escalation or attach/detach its escalation path.

Input Parameters

string
required
Thread to update.
boolean
Detach the current escalation path.
string
Path to attach; omit for an immediate escalation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_FETCH_COMPANYTool to fetch company details by ID. Use when you need the full profile of a company, including name, domain, contract value, owner info, and timestamps.

Input Parameters

string
required
Plain’s internal ID of the company to fetch, e.g., ‘cmp_01H1P4TE62AS5KZ4CZFC0578ED’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_FETCH_ISSUESFetches external issue tracker links (Jira, Linear, GitHub, etc.) associated with a customer’s threads. Returns a bounded, flattened snapshot of issue links across the customer’s threads, including thread context. With defaults, it examines up to 50 threads and 50 links per thread; results may be truncated at either limit.

Input Parameters

Maximum number of issue links to fetch per thread. Must be between 1-100. Defaults to 50.
string
required
The unique identifier of the customer whose external issue tracker links (Jira, Linear, etc.) are to be retrieved.
integer
Maximum number of customer threads to fetch. Must be between 1-100. Defaults to 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_FETCH_TIERFetch a tier by ID. Set include_details=true to include memberships and SLA configuration, which require additional permissions.

Input Parameters

string
required
The unique identifier of the tier to fetch (e.g., ‘tier_123’)
boolean
Whether to include memberships and detailed SLA configuration. Defaults to false so an ordinary tier read only requires tier:read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_AUTORESPONDERFetch a native Plain autoresponder by ID through a machine-user-safe list query. Returns no result when the list is exhausted without a match; fails if pagination cannot be exhausted within 25 pages.

Input Parameters

string
required
Native autoresponder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_CUSTOMER_BY_EMAILFetch customer details by email address. Returns customer information if found, or null if no customer exists with that email.

Input Parameters

string
required
Email address of the customer to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_CUSTOMER_BY_EXTERNAL_IDFetch a customer by the exact stable external ID from your own system.

Input Parameters

string
required
Exact customer external ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_CUSTOMER_BY_IDRetrieve a customer’s ID, full name, email address, and creation and update timestamps by customer ID.

Input Parameters

string
required
The unique identifier of the customer to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_CUSTOMER_GROUPFetch one customer group by its Plain ID. Plain’s live API requires customerGroup:read for this query.

Input Parameters

string
required
Plain ID of the customer group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_CUSTOMERSTool to fetch a list of customers. Use when retrieving multiple customer records with pagination, filtering, or sorting.

Input Parameters

integer
Number of customers to fetch before the ‘before’ cursor. Must be ≥ 1.
string
Cursor for forward pagination. Use with ‘first’.
integer
Number of customers to fetch after the ‘after’ cursor. Must be ≥ 1.
string
Cursor for backward pagination. Use with ‘last’.
object
Sorting instructions for the customers list.
object
Filters to apply when fetching customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_DISCUSSIONFetch metadata for one EMAIL or SLACK side-conversation by ID. Live provider authorization requires threadDiscussion:read, although the current public operation page does not state that permission.

Input Parameters

string
required
EMAIL or SLACK side-conversation ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_KNOWLEDGE_GAPFetch one AI-detected knowledge gap and its linked task and signals.

Input Parameters

string
required
Plain knowledge-gap ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_LABEL_TYPEFetch one label type by Plain ID or external ID.

Input Parameters

string
Label-type external ID.
string
Plain label-type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_SERVICE_LEVEL_AGREEMENT_POLICYFetch one SLA policy by its Plain ID.

Input Parameters

string
required
Plain SLA policy ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_SNIPPETFetch one snippet by ID, including a soft-deleted snippet.

Input Parameters

string
required
Snippet ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_TASKFetch one task by either its Plain ID or human-readable T-123 ref.

Input Parameters

string
Human-readable task ref such as T-123.
string
Plain task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_TENANTFetch one tenant by its Plain ID, including current custom field values.

Input Parameters

string
required
Plain ID of the tenant to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_THREAD_BY_IDFetch a thread by ID, including customer info, status, priority, labels, and assignments. If not found, the thread field in the GraphQL response is null.

Input Parameters

string
required
Unique thread identifier in format: prefix_26chars (e.g., th_01ABC…). Use LIST_THREADS or CREATE_THREAD to obtain valid IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_THREAD_BY_REFERENCEFetch a thread by ref or by its customer-scoped external ID.

Input Parameters

string
Human-readable thread ref.
string
Customer ID that scopes an external-ID lookup.
string
Thread external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_GET_USER_BY_IDFetch workspace user/team member by ID. Returns detailed information about a workspace team member including their name, email, status, and avatar. Note: This fetches workspace users (team members), not customers. Use GET_CUSTOMER_BY_ID for customer data.

Input Parameters

string
required
Unique identifier of the workspace user/team member to fetch (format: u_XXXXXX)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_IMPORT_THREADImport one historical thread without triggering SLAs or autoresponders.

Input Parameters

string
required
Original thread title.
string ("TODO" | "SNOOZED" | "DONE")
required
Imported thread status.
integer
required
Priority from 0 through 3.
string
Tenant ID; customer must be a member.
string
required
Original ISO 8601 creation time.
object
Initial user or machine-user assignee.
string
required
Idempotent source-system thread ID.
string
Thread description.
string
Source-system thread URL.
array
Initial label-type IDs.
object
required
Status-compatible detail.
object
required
Existing customer selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_IMPORT_THREAD_MESSAGESImport up to 25 historical messages and return one result per input message. Reusing a message externalId is idempotent and returns NOOP. The batch is non-atomic: successful messages remain committed when others fail, with per-message results and a top-level bulk_partial_failure error. Attachments require previously uploaded IDs.

Input Parameters

string
required
Destination thread ID.
array
required
One to 25 historical messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_AI_FEEDBACKList feedback submitted on Plain AI features, optionally filtered by feature, sentiment, or time.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional AI feedback filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_AUTORESPONDERSList native Plain autoresponders in priority order.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_CUSTOMER_GROUPSList one paginated page of customer groups with optional external-ID filtering.

Input Parameters

integer
Number of groups to fetch before the ‘before’ cursor, from 1 to 100.
string
Cursor for forward pagination. Use with ‘first’.
integer
Number of groups to fetch after the ‘after’ cursor, from 1 to 100.
string
Cursor for backward pagination. Use with ‘last’.
object
Filters to apply when fetching customer groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_DELETED_THREADSList deletion-audit records for threads.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Deletion-time range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_DISCUSSIONSList only EMAIL and SLACK side-conversations with filters and pagination. Live provider authorization requires threadDiscussion:read, although the current public operation page does not state that permission.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional discussion ordering.
object
EMAIL/SLACK discussion filters; channel types default to both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_GENERATED_REPLIESList current suggested replies for a thread’s most recent inbound message.

Input Parameters

string
required
Thread whose current suggestions to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_KNOWLEDGE_GAPSList AI-detected knowledge gaps with status filters and useful sort orders.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional knowledge-gap sort order.
object
Optional knowledge-gap filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_LABEL_TYPESList active and/or archived label types.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
boolean
Filter by archived state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_SERVICE_LEVEL_AGREEMENT_POLICIESList named SLA policies, optionally filtering by name or target type.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional policy filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_SNIPPETSList the workspace snippet library with cursor pagination.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_TASKSList workspace tasks with pagination, filtering, and sorting.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional task sort order.
object
Optional task filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_TENANT_FIELD_SCHEMASList tenant-field schemas before reading or writing custom values.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional tenant-field schema filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_TENANTSList tenants with current filters and cursor pagination.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional tenant filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_THREAD_FIELD_SCHEMASList the workspace’s custom thread-field schemas.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_THREADSDEPRECATED: Use PLAIN_PLAIN_QUERY_THREADS instead. Lists one page of threads (support conversations) in Plain. Returns thread summaries including ID, reference, title, status, and priority. Use this action to: - Get an overview of a page of threads in the system - Fetch threads with pagination for large datasets - Find threads by browsing through the list Pagination: Use ‘first’ for forward pagination (newest first) or ‘last’ for backward pagination (oldest last). For paginated results, use the cursors from pageInfo (endCursor/startCursor) with ‘after’/‘before’ parameters. If no pagination parameters are provided, returns the provider’s default first page.

Input Parameters

integer
Number of threads to fetch in backward direction, at most 100. Use for fetching the last N threads or N threads before ‘before’ cursor. Cannot be used with ‘first’.
string
Cursor for forward pagination. Get threads after this cursor. Use with ‘first’. Obtain from pageInfo.endCursor of previous response.
integer
Number of threads to fetch in forward direction, at most 100. Use for fetching the first N threads or N threads after ‘after’ cursor. Cannot be used with ‘last’.
string
Cursor for backward pagination. Get threads before this cursor. Use with ‘last’. Obtain from pageInfo.startCursor of previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_THREADS_BY_EXTERNAL_IDList a page of threads with an external ID across all customers.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
string
required
Shared thread external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_THREADS_RICHList threads with the provider’s complete public filter and sort surface.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Thread sort order.
object
Rich thread filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_LIST_TIERSList tiers with cursor pagination. Set include_details=true to include memberships and SLA configuration, which require additional permissions.

Input Parameters

integer
Number of items to fetch in backward pagination, from 1 to 100.
string
Cursor for forward pagination, used together with ‘first’.
integer
Number of items to fetch in forward pagination, from 1 to 100.
string
Cursor for backward pagination, used together with ‘last’.
boolean
Whether each tier includes memberships and detailed SLA configuration. Defaults to false so ordinary tier reads only require tier:read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_MARK_CUSTOMER_AS_SPAMIdempotently hide a customer’s threads as spam and exclude them from metrics.

Input Parameters

string
required
Plain ID of the customer whose spam status changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_QUERY_THREADSRetrieve up to 50 threads from one page, optionally filtered by status. Omit the cursor for the first page and pass the returned end cursor to fetch the next page.

Input Parameters

string
Cursor for pagination returned by a previous call. Omit for first page. Use the cursor from each response to fetch the next page; omitting it resets to the first page.
array
Filter threads by status. Supported values: TODO, SNOOZED, DONE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REMOVE_CUSTOMER_FROM_GROUPRemoves a customer from one or more customer groups in Plain. Use this action to revoke customer group memberships. The customer must be a member of the specified group(s) - attempting to remove a customer from a group they’re not in will result in an error. Groups can be identified by their Plain internal ID (customerGroupId), unique key (customerGroupKey), or external ID (externalId). Common use cases: - Downgrade customer tier (e.g., remove from premium_tier group) - Remove customer from beta access groups - Clean up group memberships after customer status changes

Input Parameters

string
required
Plain customer ID (format: ‘c_01ABC…’) of the customer to remove from groups.
array
required
One to 25 customer groups to remove the customer from. Each identifier must specify exactly one of customerGroupId, customerGroupKey, or externalId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REMOVE_CUSTOMER_FROM_TENANTSIdempotently remove a customer from one or more tenants.

Input Parameters

array
required
One or more tenants to add or remove.
object
required
Customer whose memberships change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REMOVE_LABELSRemove one or more concrete labels from a thread.

Input Parameters

array
required
Concrete label IDs to remove from their thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REMOVE_MEMBERS_FROM_TIERRemove up to 25 tenants or companies from their current tiers.

Input Parameters

array
required
Tenants or companies to remove from their tiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REORDER_AUTORESPONDERSReorder native autoresponders in one call.

Input Parameters

array
required
Autoresponders and their new orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REORDER_THREAD_FIELD_SCHEMASReorder one or more thread-field schemas.

Input Parameters

array
required
Schemas and their new orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_REPLY_TO_EMAILImmediately and irreversibly send an external reply to an inbound email. Plain inherits the primary recipients and email channel from the referenced inbound email. The request can add CC and BCC recipients or send from a verified alternate support address while preserving email-client threading.

Input Parameters

string
Optional replacement subject for the reply.
string
required
Plain-text reply body.
array
IDs of previously uploaded EMAIL attachments, at most 100.
string
Markdown version of the same reply body.
array
BCC recipients.
string
required
Plain ID of the inbound email being replied to.
boolean
Whether Plain should categorize the reply as hidden from the user.
array
CC recipients.
object
Verified workspace support address to send from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_RUN_GRAPHQL_QUERYExecute an arbitrary GraphQL document against Plain without a safety gate; mutations can immediately and irreversibly change data. This tool cannot predeclare sufficient permissions for every operation and field. GraphQL errors without data raise an error; partial responses can include errors.

Input Parameters

string
required
A valid arbitrary GraphQL query or mutation string for Plain API. Use this only for an operation not covered by a specific action, after inspecting the complete document. Mutations may immediately and irreversibly create, deliver, update, or delete external data; this tool does not classify or confirm them. Authorization is operation- and selected-field-dependent, so the tool cannot predeclare sufficient permissions: the connected credential must already grant every permission required by the supplied document. Supports queries, mutations, inline fragments, and variables. DateTime fields (e.g., createdAt, updatedAt) are objects requiring subfield selection: use createdAt { iso8601 } — omitting subfields causes GRAPHQL_VALIDATION_FAILED. For paginated connections, request pageInfo { hasNextPage endCursor } and pass endCursor as the cursor argument in subsequent queries.
object
Variables for the GraphQL operation. Keys must match variable names in the query (without ’$’). Use empty dict {} if no variables needed. Date range filter values must be UTC-normalized; non-UTC timestamps in createdAt or updatedAt filters silently exclude boundary records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SEARCH_CUSTOMERSSearch customer profile fields or timeline text using explicit OR conditions.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional filters applied in addition to the search query.
object
required
Customer attributes and expressions to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SEARCH_TENANTSSearch tenants by name, domain, or exact external ID.

Input Parameters

integer
Number of records to return moving backward.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional filters applied in addition to the search query.
object
required
Tenant search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SEARCH_THREADSSearch thread titles, messages, and customer names or emails.

Input Parameters

integer
Number of records to return moving backward.
string
required
Case-insensitive full-text search term.
string
Cursor after which to return records. Use with first.
integer
Number of records to return moving forward.
string
Cursor before which to return records. Use with last.
object
Optional rich filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SEND_DISCUSSION_MESSAGEImmediately and irreversibly deliver a message in an existing discussion. The discussion ID determines the external recipients and original EMAIL or SLACK channel; they cannot be reviewed or overridden here. Live provider authorization requires threadDiscussionMessage:create, although the current operation page omits it.

Input Parameters

string
required
Existing EMAIL or SLACK side-conversation ID. Sidekick and agent-session discussions are intentionally unsupported.
array
Previously uploaded THREAD_DISCUSSION attachment IDs.
string
required
Message body in Markdown.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SEND_MESSAGEImmediately and irreversibly deliver a message through an existing thread. The thread determines the delivery channel and primary recipient or channel; this action does not let the caller review or override them. Email threads can add CC and BCC recipients. By default Plain sends as the connected machine user, while impersonation can make the message appear from a customer or an allow-listed workspace user.

Input Parameters

string
required
Unique identifier of the thread to reply to
string
required
Plain text content of the message. If you want to send markdown-formatted content, provide the same content here and in markdownContent.
array
IDs of previously uploaded attachments to include, at most 100
object
Send as exactly one customer or allow-listed Plain workspace user
string
Optional markdown-formatted content of the message. If provided, textContent should contain the plain text version of the same content.
object
Channel-specific options such as email CC/BCC recipients

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SEND_NEW_EMAILImmediately and irreversibly send an external email to a customer. Plain uses the customer’s email as the primary recipient. The request can add CC and BCC recipients, send from a verified alternate support address, and attach the email to an existing thread; the delivery channel remains email.

Input Parameters

string
required
Email subject line.
string
Existing thread to attach the email to; omit to create a thread.
string
required
Plain ID of the recipient customer.
string
required
Plain-text email body.
array
IDs of previously uploaded EMAIL attachments, at most 100.
string
Markdown version of the same email body for rich-text clients.
array
BCC recipients.
boolean
Whether Plain should categorize the email as hidden from the user.
array
CC recipients.
object
Verified workspace support address to send from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_SET_CUSTOMER_TENANTSReplace a customer’s complete tenant membership set in one call.

Input Parameters

array
required
Complete tenant set; an empty list removes all memberships.
object
required
Customer whose memberships are replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_TRANSITION_THREAD_STATUSMove a thread to Todo, Snoozed, or Done.

Input Parameters

string ("TODO" | "SNOOZED" | "DONE")
required
Destination status.
string
required
Thread to transition.
string ("CREATED" | "IN_PROGRESS" | "NEW_REPLY" | "THREAD_LINK_UPDATED" | "THREAD_DISCUSSION_RESOLVED" | "WAITING_FOR_CUSTOMER" | "WAITING_FOR_DURATION" | "WAITING_INDEFINITELY" | "IGNORED" | "DONE_MANUALLY_SET" | "DONE_AUTOMATICALLY_SET")
Provider status-detail enum value.
integer
Snooze duration in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UNARCHIVE_LABEL_TYPERestore an archived label type for use on new threads.

Input Parameters

string
required
Label-type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UNMARK_CUSTOMER_AS_SPAMIdempotently clear a customer’s spam flag and restore inbox visibility.

Input Parameters

string
required
Plain ID of the customer whose spam status changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_AUTORESPONDERUpdate an autoresponder that automatically sends outbound customer replies. Enabling or changing a matching autoresponder can cause irreversible external messages. Plain permits at most 25 autoresponders per workspace and delays up to 900 seconds.

Input Parameters

object
Wrapped replacement name.
object
Wrapped replacement order.
object
Wrapped enabled-state update.
array
Replacement conditions.
object
Wrapped text-body update.
array
Replacement sources.
string
required
Autoresponder to update.
object
Wrapped markdown-body update.
object
Wrapped response-delay update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_COMPANYUpserts (creates or updates) a company in Plain. Provide companyId to update by ID or companyDomainName to upsert by domain. When both identifiers are omitted, domainName is also used as companyDomainName for compatibility. Use this to create new companies, update existing company details (name, domain, contract value), or assign account owners.

Input Parameters

string
required
Name for the company.
string
Existing company ID to update (format: ‘co_…’). Provide this or companyDomainName. If both identifiers are omitted, domainName is used as companyDomainName.
string
required
Domain name for the company (e.g., ‘acme.com’).
integer
Optional contract value in cents. Must be non-negative; pass null explicitly to clear it.
string
Company domain name for lookup/upsert (e.g., ‘acme.com’). Provide this or companyId. If both identifiers are omitted, this defaults to domainName; an explicit null or empty value is rejected instead of defaulted.
string
ID of the user to assign as account owner; pass null explicitly to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_COMPANY_TIERAssign one company to a tier or clear its tier membership.

Input Parameters

boolean
Set true, without tierIdentifier, to remove the company from its tier.
object
Tier to assign. Omit it only when remove_tier is true.
object
required
Company whose tier is changing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_GENERATED_REPLYRecord teammate feedback on a generated reply.

Input Parameters

object
required
Teammate feedback to record. type is required; its wrapped value may be POSITIVE, NEGATIVE, UNKNOWN, or null to clear existing feedback.
string
required
Generated reply to review.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_LABEL_TYPEUpdate mutable label-type properties using field wrappers.

Input Parameters

object
Wrapped icon update.
object
Wrapped replacement name.
object
Wrapped color update.
object
Wrapped external-ID update.
object
Wrapped description update.
string
required
Label type to update.
object
Wrapped AI-exclusion update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_NOTEReplace an internal note’s content and optional attachment list.

Input Parameters

string
required
Replacement plain-text note body.
string
required
Note to update.
string
Replacement Markdown note body.
array
Complete replacement list of uploaded NOTE attachment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_SERVICE_LEVEL_AGREEMENTUpdate a legacy tier SLA without changing its SLA type.

Input Parameters

array
Replacement pre-breach actions.
object
Wrapped replacement priority filter.
object
Wrapped replacement next-response target.
string
required
Plain ID of the legacy SLA to update.
object
Replacement label-type filter.
array
Replacement business-hours schedules; empty means 24/7.
object
Wrapped replacement first-response target.
object
Wrapped replacement pause statuses.
object
Wrapped replacement first-resolution target.
object
Wrapped replacement total-resolution target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_SERVICE_LEVEL_AGREEMENT_POLICYReplace an SLA policy’s targets; omitted target types and their trackers are deleted.

Input Parameters

object
Wrapped replacement policy name.
array
required
Complete replacement set of policy targets.
object
Wrapped description; null clears it.
string
required
Plain SLA policy ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_SNIPPETUpdate selected snippet fields using Plain’s field-level wrappers.

Input Parameters

object
Wrapped replacement name; omit to leave unchanged.
object
Wrapped replacement path; set value to null to clear it.
object
Wrapped replacement plain-text body.
object
Wrapped replacement Markdown body.
string
required
Snippet to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_TASKUpdate selected fields on an existing task.

Input Parameters

string
Replacement task title.
string ("TODO" | "IN_PROGRESS" | "DONE" | "CANCELLED")
Replacement lifecycle status.
string
required
Plain task ID to update.
integer
Replacement priority from 0 to 3.
string
Optional parent tenant ID. On update, setting this clears any existing company parent; omitting it leaves the current parent unchanged.
string
Optional parent account ID.
string
Optional parent company ID. On update, setting this clears any existing tenant parent; omitting it leaves the current parent unchanged.
object
Replacement user or machine-user assignee.
string
Replacement task description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_TENANT_TIERAssign one tenant to a tier or clear its tier membership.

Input Parameters

boolean
Set true, without tierIdentifier, to remove the tenant from its tier.
object
Tier to assign. Omit it only when remove_tier is true.
object
required
Tenant whose tier is changing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_THREADTool to update a thread’s title. Use when renaming a thread after confirming its ID.

Input Parameters

string
required
New title for the thread
string
required
Unique identifier of the thread to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_THREAD_ATTRIBUTESChange one thread priority, customer, external ID, tenant, or tier attribute.

Input Parameters

integer
New priority.
string
required
Thread to update.
boolean
Detach the current tier.
string
New customer ID.
string
New external ID. Use clearExternalId to remove it.
boolean
Detach the current tenant.
boolean
Change priority only while it remains the default.
object
New tier selector.
boolean
Clear the current external ID.
object
New tenant selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_THREAD_FIELD_SCHEMAUpdate mutable properties of a thread-field schema.

Input Parameters

object
Wrapped replacement label.
integer
Replacement order.
array
Replacement ENUM values.
boolean
Replacement required flag.
object
Wrapped replacement description.
object
Wrapped ISO 8601 date default update.
boolean
Replacement client-readonly flag.
object
Wrapped numeric default update.
object
Wrapped string default update.
object
Wrapped boolean default update.
boolean
Replacement AI auto-fill flag.
boolean
Replacement agent-availability flag.
string
required
Schema to update.
object
Wrapped dependency update.
array
Replacement label dependencies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_THREAD_SERVICE_LEVEL_AGREEMENT_POLICYApply an SLA policy, or clear it so the thread falls back to its tier’s SLAs.

Input Parameters

string
required
Thread receiving or clearing the policy.
string
required
Policy to apply, or null to clear it and fall back to the tier SLAs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPDATE_TIERUpdate selected fields on an existing support tier.

Input Parameters

object
Wrapped replacement nonblank tier name.
object
Wrapped replacement #RRGGBB tier color.
string
required
Plain tier ID.
object
Wrapped replacement default-tier flag.
object
Wrapped external ID; null clears it.
object
Wrapped replacement default thread priority.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPSERT_CUSTOMERTool to upsert (create or update) a customer. Use when syncing or ensuring a customer record exists before subsequent actions.

Input Parameters

object
required
Details for creation if not found.
object
required
Details for update if found.
object
required
Selector for existing customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPSERT_CUSTOMER_GROUPIdempotently create or update a customer group using machine-user-safe calls.

Input Parameters

string
required
Unique human-readable customer-group key.
string
required
Customer-group display name.
string
required
Six-digit hexadecimal customer-group color, including ’#’.
string
Customer-group ID from your own system.
object
required
Exactly one identifier used to find an existing customer group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPSERT_TENANTCreate or update a tenant while synchronizing its stable external ID.

Input Parameters

object
URL update; use a null value to clear the URL.
string
required
Tenant display name.
string
required
Stable tenant ID from your own system.
object
required
Exactly one identifier used to find an existing tenant.
object
Beta primary-domain update; use a null value to clear it.
object
Beta complete alternate-domain list to set.
object
Beta setting for automatic membership by matching email domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPSERT_TENANT_FIELDSet one typed custom field value for a tenant.

Input Parameters

string ("STRING_TYPE" | "NUMBER_TYPE" | "BOOLEAN_TYPE" | "STRING_ARRAY" | "DATETIME_TYPE" | "USER_REFERENCE_TYPE" | "TENANT_REFERENCE_TYPE")
required
Type of the tenant-field schema.
string
ISO 8601 value for DATETIME_TYPE.
array
Value for STRING_ARRAY.
number
Value for NUMBER_TYPE.
string
Value for STRING_TYPE.
boolean
Value for BOOLEAN_TYPE.
array
One or more Plain user IDs for USER_REFERENCE_TYPE. To remove the field value, call DeleteTenantField instead.
object
required
Tenant and field to update.
array
One or more Plain tenant IDs for TENANT_REFERENCE_TYPE. To remove the field value, call DeleteTenantField instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLAIN_UPSERT_TENANT_FIELD_SCHEMASCreate or update tenant-field schemas keyed by source and external field ID.

Input Parameters

array
required
Tenant-field schemas to create or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: PLAIN_CUSTOMER_EVENTType: webhookFires when a customer in Plain is created, updated or deleted.event_type says which it was, created, updated or deleted, in the same vocabulary the config filters on — so a single subscription to all three can branch downstream without matching on Plain’s raw event names.Group membership changes are a separate slug, customer_group_membership_changed.

Configuration

array
Only fire for these kinds of event, e.g. ['created', 'deleted']. Choose from created, updated and deleted. Leave unset to fire for every kind.

Payload

object
A customer record in Plain.
string ("created" | "updated" | "deleted")
required
What happened to the customer: created, updated or deleted.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
A customer record in Plain.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_CUSTOMER_GROUP_CHANGEDType: webhookFires when a customer group is created, edited or deleted in Plain.

Payload

object
A group customers can belong to, used for segmentation in Plain.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
A group customers can belong to, used for segmentation in Plain.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_CUSTOMER_GROUP_MEMBERSHIP_CHANGEDType: webhookFires when a customer is added to or removed from a customer group in Plain.Use it to re-segment a customer downstream the moment their grouping in Plain changes — move them onto a different plan’s onboarding, change who gets paged for their threads, sync the new segment into your CRM.change says which direction it was, added or removed, straight from Plain. Which group it was is the one that differs between customer.customer_group_memberships and previous_customer.customer_group_memberships, both of which carry the customer’s full membership list.

Payload

string ("added" | "removed")
required
Whether the customer joined or left a group: added or removed.
object
required
The customer with their group memberships as they are now.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
required
The same customer with their group memberships as they were before the change.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_CREATEDType: webhookFires when a new support thread is opened in Plain.

Payload

string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
required
The thread that was created.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_CUSTOM_FIELD_UPDATEDType: webhookFires when one of your own thread fields is set, changed or cleared on a Plain thread.

Payload

object
One of your own structured fields set on a thread. Exactly one of the four value fields is populated, decided by type.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
One of your own structured fields set on a thread. Exactly one of the four value fields is populated, decided by type.
object
required
The thread the field is on.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_MESSAGE_RECEIVEDType: webhookFires when an inbound message arrives on a Plain thread.Covers email, in-app chat, Slack, Discord and Microsoft Teams, and each channel ships its own message shape, so read channel before reading message. For the replies your own team sends out, use the Thread Message Sent trigger instead.

Configuration

array
Only fire for messages that arrived on these channels, e.g. ['email', 'slack']. Leave unset to fire for every channel.

Payload

string ("email" | "chat" | "slack" | "discord" | "ms_teams")
required
Channel the message arrived on, and the shape message has.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
string
required
The message itself. Each channel carries its own fields — read channel to know which shape you have.
object
required
The thread the message arrived on.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_MESSAGE_SENTType: webhookFires when your team sends a message out on a Plain thread.Covers email, in-app chat, Slack, Discord and Microsoft Teams, and each channel ships its own message shape, so read channel before reading message. Editing a Slack or Discord message afterwards does not fire it again, and for messages arriving from the customer use the Thread Message Received trigger instead.

Configuration

array
Only fire for messages sent on these channels, e.g. ['email', 'slack']. Leave unset to fire for every channel.

Payload

string ("email" | "chat" | "slack" | "discord" | "ms_teams")
required
Channel the message went out on, and the shape message has.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
string
required
The message itself. Each channel carries its own fields — read channel to know which shape you have.
object
required
The thread the message was sent on.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_NOTE_CREATEDType: webhookFires when an internal note is added to a thread in Plain.Carries no mentions: Plain only reports them on its separate mention event, which is PLAIN_THREAD_NOTE_MENTIONED. Subscribing to both slugs delivers every mentioning note twice, under two different event ids.

Payload

string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
required
The note that was added.
object
required
The thread the note was added to.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_NOTE_MENTIONEDType: webhookFires when an internal note mentions a machine user in Plain.The only event that carries mentions. The raw <@mu_…> markup is not guaranteed in either note.text or note.markdown, so this slug — not scanning the note body — is how a consumer learns who was mentioned.Plain publishes such a note twice, here and as thread.note_created, so subscribing to both this and PLAIN_THREAD_NOTE_CREATED delivers it twice, under two different event ids.

Payload

string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
array
Machine users the note mentions. Plain reports mentions of machine users only, never of human teammates.
object
required
The note that was added.
object
required
The thread the note was added to.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_PROPERTIES_UPDATEDType: webhookFires when a thread’s status, assignee, priority or labels change in Plain.Every event carries the thread’s new state alongside its state immediately before the change, and names which of the four properties changed. Assignment events also cover reassignment, so both sides can be populated.

Configuration

array
Only fire when one of these properties changed, e.g. ['status', 'priority']. Choose from status, assignment, priority and labels. Leave unset to fire for all four.

Payload

string ("status" | "assignment" | "priority" | "labels")
required
Which property changed: status, assignment, priority or labels.
string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
required
The thread as it was immediately before the change.
object
required
The thread after the change.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.
Slug: PLAIN_THREAD_TENANT_UPDATEDType: webhookFires when a thread’s tenant is set, changed or cleared in Plain.Plain also sends this event when a thread’s tenant is reapplied without changing, in which case both sides hold the same tenant or both are null.

Payload

string
required
Unique id of this event (e.g. pEv_…), stable across Plain’s delivery retries.
object
A tenant — the account or organisation a thread belongs to.
object
A tenant — the account or organisation a thread belongs to.
object
required
The thread whose tenant changed.
string
required
ISO 8601 time the event happened in Plain.
string
required
Id of the Plain workspace the event came from.