Plain
plainPlain is a collaborative support platform for B2B support teams, offering a modern, AI-powered interface to consolidate support channels and assist customers efficiently.
Acciones disponibles (23)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Customer To GroupPLAIN_ADD_CUSTOMER_TO_GROUPAcciónTool to add a customer to one or more customer groups. use when you have a customer and groups ready.
PLAIN_ADD_CUSTOMER_TO_GROUPAcciónTool to add a customer to one or more customer groups. use when you have a customer and groups ready.
Parámetros de entrada
customerIdstringObligatorioID of the customer to add to groups.
customerGroupIdentifiersobject[]ObligatorioList of customer group identifiers. Must contain at least one identifier.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CustomerPLAIN_CREATE_CUSTOMERAcciónTool to create a customer. use after gathering email and full name to provision a new customer in plain.
PLAIN_CREATE_CUSTOMERAcciónTool to create a customer. use after gathering email and full name to provision a new customer in plain.
Parámetros de entrada
emailanyObligatorioemailCustomer's unique email address
full_namestringObligatorioThe full name of the customer (e.g. 'John Doe')
short_namestringAn optional short name, typically the first name
external_idstringYour system's ID for idempotency (optional)
email_verifiedbooleanWhether this email is already verified in Plain
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ThreadPLAIN_CREATE_THREADAcciónTool to create a new thread. use after obtaining valid customer identifier.
PLAIN_CREATE_THREADAcciónTool to create a new thread. use after obtaining valid customer identifier.
Parámetros de entrada
titlestringObligatorioTitle of the new thread
assignedToobjectOptional user assignment for the thread
componentsobject[]Optional list of content components for the thread
labelTypeIdsstring[]Optional list of label type IDs to assign
customerIdentifierobjectObligatorioIdentifier object for the customer
Parámetros de salida
dataobjectObligatorioGraphQL response payload
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CustomerPLAIN_DELETE_CUSTOMERAcciónTool to delete a customer from the system. use when you need to remove a customer by their id.
PLAIN_DELETE_CUSTOMERAcciónTool to delete a customer from the system. use when you need to remove a customer by their id.
Parámetros de entrada
customer_idstringObligatorioUnique identifier of the customer to delete, as returned by the Plain API.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete UserPLAIN_DELETE_USERAcciónTool to delete a user from the system. use when you need to remove a user by their id after confirming existence.
PLAIN_DELETE_USERAcciónTool to delete a user from the system. use when you need to remove a user by their id after confirming existence.
Parámetros de entrada
user_idstringObligatorioUnique identifier of the user to delete, as returned by the Plain API.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch CompanyPLAIN_FETCH_COMPANYAcciónTool 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.
PLAIN_FETCH_COMPANYAcciónTool 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.
Parámetros de entrada
company_idstringObligatorioPlain's internal ID of the company to fetch, e.g., 'cmp_01H1P4TE62AS5KZ4CZFC0578ED'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch IssuesPLAIN_FETCH_ISSUESAcciónTool to fetch external issue links for a customer. use when you need to list all issues across a customer's threads.
PLAIN_FETCH_ISSUESAcciónTool to fetch external issue links for a customer. use when you need to list all issues across a customer's threads.
Parámetros de entrada
linkFirstintegerThe number of issue links to fetch per thread. Must be ≥1.
customerIdstringObligatorioThe unique identifier of the customer whose issues are to be retrieved.
threadFirstintegerThe number of threads to fetch for the customer. Must be ≥1.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch TierPLAIN_FETCH_TIERAcciónTool 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".
PLAIN_FETCH_TIERAcciónTool 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".
Parámetros de entrada
tier_idstringObligatorioThe unique identifier of the tier to fetch (e.g., 'tier_123')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer By EmailPLAIN_GET_CUSTOMER_BY_EMAILAcciónTool to fetch customer details by email. use after confirming the email exists to retrieve detailed customer information.
PLAIN_GET_CUSTOMER_BY_EMAILAcciónTool to fetch customer details by email. use after confirming the email exists to retrieve detailed customer information.
Parámetros de entrada
emailanyObligatorioemailEmail address of the customer to fetch
Parámetros de salida
dataobjectObligatorioGraphQL response payload
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer By IDPLAIN_GET_CUSTOMER_BY_IDAcciónTool to retrieve details of a specific customer by their unique id. use after obtaining the customer's id to fetch their complete record.
PLAIN_GET_CUSTOMER_BY_IDAcciónTool to retrieve details of a specific customer by their unique id. use after obtaining the customer's id to fetch their complete record.
Parámetros de entrada
idstringObligatorioThe unique identifier of the customer to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CustomersPLAIN_GET_CUSTOMERSAcciónTool to fetch a list of customers. use when retrieving multiple customer records with pagination, filtering, or sorting.
PLAIN_GET_CUSTOMERSAcciónTool to fetch a list of customers. use when retrieving multiple customer records with pagination, filtering, or sorting.
Parámetros de entrada
lastintegerNumber of customers to fetch before the 'before' cursor. Must be ≥ 1.
afterstringCursor for forward pagination. Use with 'first'.
firstintegerNumber of customers to fetch after the 'after' cursor. Must be ≥ 1.
beforestringCursor for backward pagination. Use with 'last'.
sortByobjectSorting instructions for the customers list.
filtersobjectFilters to apply when fetching customers.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Thread By IDPLAIN_GET_THREAD_BY_IDAcciónTool to fetch details of a specific thread using its unique identifier. use after confirming the thread id is correct.
PLAIN_GET_THREAD_BY_IDAcciónTool to fetch details of a specific thread using its unique identifier. use after confirming the thread id is correct.
Parámetros de entrada
idstringObligatorioUnique identifier of the thread to fetch
Parámetros de salida
dataobjectObligatorioGraphQL response payload
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User By IDPLAIN_GET_USER_BY_IDAcciónTool to fetch user by id. use when you have a valid user id to retrieve detailed user information.
PLAIN_GET_USER_BY_IDAcciónTool to fetch user by id. use when you have a valid user id to retrieve detailed user information.
Parámetros de entrada
user_idstringObligatorioUnique identifier of the user to fetch
Parámetros de salida
dataobjectObligatorioGraphQL response payload with user data
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ThreadsPLAIN_LIST_THREADSAcciónTool to list all threads. use when you need to retrieve thread summaries with optional pagination.
PLAIN_LIST_THREADSAcciónTool to list all threads. use when you need to retrieve thread summaries with optional pagination.
Parámetros de entrada
lastintegerNumber of threads to fetch before the 'before' cursor. Must be ≥ 1.
afterstringCursor for forward pagination. Use with 'first'.
firstintegerNumber of threads to fetch after the 'after' cursor. Must be ≥ 1.
beforestringCursor for backward pagination. Use with 'last'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TiersPLAIN_LIST_TIERSAcciónTool 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'.
PLAIN_LIST_TIERSAcciónTool 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'.
Parámetros de entrada
lastintegerNumber of items to fetch in backward pagination; must be ≥ 1.
afterstringCursor for forward pagination, used together with 'first'.
firstintegerNumber of items to fetch in forward pagination; must be ≥ 1.
beforestringCursor for backward pagination, used together with 'last'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Customer GroupPLAIN_PLAIN_CREATE_CUSTOMER_GROUPAcciónTool 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.
PLAIN_PLAIN_CREATE_CUSTOMER_GROUPAcciónTool 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.
Parámetros de entrada
keystringObligatorioUnique key for the customer group
namestringObligatorioName of the customer group
coloranyObligatorioHex color code for the group (e.g. #FF5733)
externalIdstringOptional external ID for the customer group
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Customer GroupsPLAIN_PLAIN_LIST_CUSTOMER_GROUPSAcciónTool to list all customer groups. use when you need to retrieve group metadata with optional pagination or filters.
PLAIN_PLAIN_LIST_CUSTOMER_GROUPSAcciónTool to list all customer groups. use when you need to retrieve group metadata with optional pagination or filters.
Parámetros de entrada
lastintegerNumber of groups to fetch before the 'before' cursor. Must be ≥ 1.
afterstringCursor for forward pagination. Use with 'first'.
firstintegerNumber of groups to fetch after the 'after' cursor. Must be ≥ 1.
beforestringCursor for backward pagination. Use with 'last'.
filtersobjectFilters to apply when fetching customer groups.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ThreadsPLAIN_PLAIN_QUERY_THREADSAcciónTool to retrieve a paginated list of threads. use when you need to list threads with optional status filtering.
PLAIN_PLAIN_QUERY_THREADSAcciónTool to retrieve a paginated list of threads. use when you need to list threads with optional status filtering.
Parámetros de entrada
cursorstringCursor for pagination returned by a previous call. Omit for first page.
statusesstring[]Filter threads by status. Supported values: TODO, SNOOZED, DONE.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Customer From GroupPLAIN_REMOVE_CUSTOMER_FROM_GROUPAcciónTool to remove a customer from one or more customer groups. use when you need to revoke memberships.
PLAIN_REMOVE_CUSTOMER_FROM_GROUPAcciónTool to remove a customer from one or more customer groups. use when you need to revoke memberships.
Parámetros de entrada
customerIdstringObligatorioID of the customer to remove from groups.
customerGroupIdentifiersobject[]ObligatorioList of customer group identifiers. Must contain at least one identifier.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send MessagePLAIN_SEND_MESSAGEAcciónTool to send a new message within a thread. use after identifying the thread and preparing message content.
PLAIN_SEND_MESSAGEAcciónTool to send a new message within a thread. use after identifying the thread and preparing message content.
Parámetros de entrada
threadIdstringObligatorioUnique identifier of the thread to reply to
textContentstringPlain text content of the message
impersonationobjectImpersonate a customer when sending the message
markdownContentstringMarkdown-formatted content of the message; at least one of textContent or markdownContent is required
channelSpecificOptionsobjectChannel-specific options such as email CC/BCC recipients
Parámetros de salida
dataobjectObligatorioGraphQL response payload
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CompanyPLAIN_UPDATE_COMPANYAcciónTool to update an existing company's details. use when modifying a company's name or domain.
PLAIN_UPDATE_COMPANYAcciónTool to update an existing company's details. use when modifying a company's name or domain.
Parámetros de entrada
namestringObligatorioNew name for the company.
companyIdstringObligatorioUnique ID of the existing company to update.
domainNamestringObligatorioNew domain name for the company (e.g., 'acme.com').
contractValueintegerOptional contract value in cents. Must be non-negative.
accountOwnerUserIdstringID of the user to assign as account owner.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ThreadPLAIN_UPDATE_THREADAcciónTool to update a thread's title. use when renaming a thread after confirming its id.
PLAIN_UPDATE_THREADAcciónTool to update a thread's title. use when renaming a thread after confirming its id.
Parámetros de entrada
titlestringObligatorioNew title for the thread
threadIdstringObligatorioUnique identifier of the thread to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upsert CustomerPLAIN_UPSERT_CUSTOMERAcciónTool to upsert (create or update) a customer. use when syncing or ensuring a customer record exists before subsequent actions.
PLAIN_UPSERT_CUSTOMERAcciónTool to upsert (create or update) a customer. use when syncing or ensuring a customer record exists before subsequent actions.
Parámetros de entrada
onCreateobjectObligatorioDetails for creation if not found.
onUpdateobjectObligatorioDetails for update if found.
identifierobjectObligatorioSelector for existing customer.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not