Plain

Learn how to use Plain with Composio

Overview

Enum

PLAIN

Description

Plain is a collaborative support platform for B2B support teams, offering a modern, AI-powered interface to consolidate support channels and assist customers efficiently.

Authentication Details

api_key
stringRequired

Actions

Tool to add a customer to one or more customer groups. use when you have a customer and groups ready.

Action Parameters

customerGroupIdentifiers
arrayRequired
customerId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to create a customer. use after gathering email and full name to provision a new customer in plain.

Action Parameters

email
Required
email_verified
boolean
external_id
string
full_name
stringRequired
short_name
string

Action Response

data
object
error
string
successful
boolean
Tool to create a new customer group. use when needing to group customers for segmentation. creates a new customer group with specified name, key, color, and optional externalid.

Action Parameters

color
Required
externalId
string
key
stringRequired
name
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to create a new thread. use after obtaining valid customer identifier.

Action Parameters

assignedTo
object
components
array
customerIdentifier
objectRequired
labelTypeIds
array
title
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a customer from the system. use when you need to remove a customer by their id.

Action Parameters

customer_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a user from the system. use when you need to remove a user by their id after confirming existence.

Action Parameters

user_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool 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.

Action Parameters

company_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to fetch external issue links for a customer. use when you need to list all issues across a customer's threads.

Action Parameters

customerId
stringRequired
linkFirst
integerDefaults to 50
threadFirst
integerDefaults to 50

Action Response

data
object
error
string
successful
boolean
Tool to fetch a tier by its id. use when you have a tier id and need its metadata before proceeding. example: "fetch tier with id tier 123".

Action Parameters

tier_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to fetch a list of customers. use when retrieving multiple customer records with pagination, filtering, or sorting.

Action Parameters

after
string
before
string
filters
object
first
integer
last
integer
sortBy
object

Action Response

data
object
error
string
successful
boolean
Tool to fetch customer details by email. use after confirming the email exists to retrieve detailed customer information.

Action Parameters

email
Required

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific customer by their unique id. use after obtaining the customer's id to fetch their complete record.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to fetch details of a specific thread using its unique identifier. use after confirming the thread id is correct.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to fetch user by id. use when you have a valid user id to retrieve detailed user information.

Action Parameters

user_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to list all customer groups. use when you need to retrieve group metadata with optional pagination or filters.

Action Parameters

after
string
before
string
filters
object
first
integer
last
integer

Action Response

data
object
error
string
successful
boolean
Tool to list all threads. use when you need to retrieve thread summaries with optional pagination.

Action Parameters

after
string
before
string
first
integer
last
integer

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a list of tiers with pagination. use when you need to browse available tiers after determining pagination cursors. example: 'list tiers with first=25'.

Action Parameters

after
string
before
string
first
integer
last
integer

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a paginated list of threads. use when you need to list threads with optional status filtering.

Action Parameters

cursor
string
statuses
array

Action Response

data
object
error
string
successful
boolean
Tool to remove a customer from one or more customer groups. use when you need to revoke memberships.

Action Parameters

customerGroupIdentifiers
arrayRequired
customerId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to send a new message within a thread. use after identifying the thread and preparing message content.

Action Parameters

channelSpecificOptions
object
impersonation
object
markdownContent
string
textContent
string
threadId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to update an existing company's details. use when modifying a company's name or domain.

Action Parameters

accountOwnerUserId
string
companyId
stringRequired
contractValue
integer
domainName
stringRequired
name
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to update a thread's title. use when renaming a thread after confirming its id.

Action Parameters

threadId
stringRequired
title
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to upsert (create or update) a customer. use when syncing or ensuring a customer record exists before subsequent actions.

Action Parameters

identifier
objectRequired
onCreate
objectRequired
onUpdate
objectRequired

Action Response

data
object
error
string
successful
boolean