Pylon is a B2B customer support platform that helps teams manage support tickets across multiple channels including Slack, Email, Microsoft Teams, and more
pylon.getIssue
issueIdOrTicketNumber
(TEXT, Required): The unique identifier or ticket number of the issuepylon.searchIssues
filterField
(SELECT, Optional): The field to filter by (created_at, account_id, ticket_form_id, requester_id, follower_user_id, follower_contact_id, state, tags, title, body_html, or custom field slug)
filterOperator
(SELECT, Optional): The operator to use for filtering (equals, in, not_in, contains, does_not_contain, string_contains, string_does_not_contain, time_is_after, time_is_before, time_range)filterValue
(TEXT, Optional): The value to filter by (for single value operators like equals, string_contains, time_is_after, time_is_before)filterValues
(TEXT, Optional): JSON array of values for operators: in, not_in, contains, does_not_containstartTime
(TEXT, Optional): Start time for time_range operator (RFC3339 format)endTime
(TEXT, Optional): End time for time_range operator (RFC3339 format)cursor
(TEXT, Optional): Cursor for paginationlimit
(NUMBER, Optional): Number of issues to fetch (1-1000, default 100)pylon.createIssue
title
(TEXT, Required): The title of the issue
bodyHtml
(MULTI_LINE_TEXT, Optional): The HTML content of the issue. Use HTML tags (e.g., <p>, <strong>, <ul>)
. Markdown syntax will NOT be renderedaccountId
(TEXT, Optional): The ID of the account associated with this issueassigneeId
(TEXT, Optional): The ID of the user to assign this issue toteamId
(TEXT, Optional): The ID of the team to assign this issue topriority
(SELECT, Optional): The priority of the issue (low, medium, high, urgent)requesterEmail
(TEXT, Optional): Email of the person requesting this issuerequesterId
(TEXT, Optional): ID of the requesterrequesterName
(TEXT, Optional): Name of the requesterrequesterAvatarUrl
(TEXT, Optional): URL to the requester’s avatar imagetags
(TEXT, Optional): Tags for the issue (JSON array)customFields
(TEXT, Optional): Custom fields (JSON array)attachmentUrls
(TEXT, Optional): URLs to attachments (JSON array)destination
(TEXT, Optional): Destination for the issue (e.g., email, slack)destinationEmail
(TEXT, Optional): Email address for the destinationemailCcs
(TEXT, Optional): CC email addresses (JSON array)emailBccs
(TEXT, Optional): BCC email addresses (JSON array)createdAt
(TEXT, Optional): Timestamp when issue was created (RFC3339 format)userId
(TEXT, Optional): ID of the user creating the issuecontactId
(TEXT, Optional): ID of the contact associated with the issuepylon.listIssues
startTime
(TEXT, Optional): Start time for filtering issues (RFC3339 format)
endTime
(TEXT, Optional): End time for filtering issues (RFC3339 format)pylon.deleteIssue
issueId
(TEXT, Required): The ID of the issue to deletepylon.updateIssue
issueId
(TEXT, Required): The ID of the issue to update
assigneeId
(TEXT, Optional): The ID of the user to assign (empty string removes assignee)teamId
(TEXT, Optional): The ID of the team to assign (empty string removes team)state
(SELECT, Optional): The state of the issue (new, in_progress, waiting, closed)requesterId
(TEXT, Optional): ID of the requester to updatecustomerPortalVisible
(SELECT, Optional): Whether the issue is visible in the customer portal (true, false)tags
(TEXT, Optional): Updated tags for the issue (JSON array)customFields
(TEXT, Optional): Updated custom fields (JSON array)pylon.addDraftReplytoIssue
issueId
(TEXT, Required): The unique identifier of the issue
draftResponse
(MULTI_LINE_TEXT, Required): The draft reply content to add to the issuepylon.addNotetoIssue
issueId
(TEXT, Required): The unique identifier of the issue
content
(MULTI_LINE_TEXT, Required): The HTML content of the note. Use HTML tags like <p>, <strong>, <ul><li>, <h3>
. DO NOT use Markdown syntax like bold or - lists as it will be strippedpylon.snoozeIssue
issueId
(TEXT, Required): The ID or number of the issue to snooze
snoozeUntil
(TEXT, Required): Timestamp to snooze the issue until (RFC3339 format)pylon.getIssueFollowers
issueId
(TEXT, Required): The ID or number of the issuepylon.getIssueMessages
issueId
(TEXT, Required): The unique identifier of the issuepylon.manageIssueFollowers
issueId
(TEXT, Required): The ID or number of the issue
operation
(SELECT, Optional): Whether to add or remove followers (add, remove)userIds
(TEXT, Optional): User IDs to add/remove as followers (JSON array)contactIds
(TEXT, Optional): Contact IDs to add/remove as followers (JSON array)pylon.manageExternalIssues
issueId
(TEXT, Required): The ID of the Pylon issue
operation
(SELECT, Required): Whether to link or unlink external issues (link, unlink)source
(TEXT, Required): The source system (e.g., linear, jira)externalId
(TEXT, Required): The ID of the external issuelink
(TEXT, Optional): URL link to the external issuepylon.redactMessage
messageId
(TEXT, Required): The ID of the message to redactpylon.listAccounts
cursor
(TEXT, Optional): The cursor to use for pagination
limit
(NUMBER, Optional): Number of accounts to fetch (1-1000, default: 100)pylon.createAccount
name
(TEXT, Required): The name of the account
domains
(TEXT, Optional): List of domains (comma-separated, e.g., acme.com, acme.org)primaryDomain
(TEXT, Optional): Primary domain (must be in domains list)logoUrl
(TEXT, Optional): URL to account logo (square PNG, JPG, or JPEG)tags
(TEXT, Optional): Tags for the account (JSON array, e.g., [‘enterprise’, ‘priority’])externalIds
(TEXT, Optional): External IDs (JSON array of objects, e.g., [external_id’: ‘123’, ‘label’: ‘CRM ID])customFields
(TEXT, Optional): Custom fields (JSON array, e.g., [slug’: ‘industry’, ‘value’: ‘Technology])channels
(TEXT, Optional): Channels to link (JSON array, e.g., [channel_id’: ‘ch123’, ‘source’: ‘slack’, ‘is_primary’: true}])pylon.getAccount
accountId
(TEXT, Required): The ID or external ID of the accountpylon.updateAccount
accountId
(TEXT, Required): The ID or external ID of the account to update
name
(TEXT, Optional): New name for the accountdomains
(TEXT, Optional): Updated list of domains (comma-separated)primaryDomain
(TEXT, Optional): Primary domain (must be in domains list)ownerId
(TEXT, Optional): ID of the new ownertags
(TEXT, Optional): Updated tags (JSON array)externalIds
(TEXT, Optional): Updated external IDs (JSON array)customFields
(TEXT, Optional): Updated custom fields (JSON array)channels
(TEXT, Optional): Updated channels (JSON array)keepExistingPrimaryDomain
(SELECT, Optional): If updating domains but not primary, set to true (true, false)pylon.deleteAccount
accountId
(TEXT, Required): The ID or external ID of the account to deletepylon.searchAccounts
filterField
(SELECT, Optional): Field to filter by. Each field supports different operators - check operator compatibility (domains, tags, name, external_ids)
filterOperator
(SELECT, Optional): Operator for filtering. MUST be compatible with selected field (see field descriptions) (equals, in, not_in, contains, does_not_contain)filterValue
(TEXT, Optional): Use for SINGLE value operators: equals, contains, does_not_contain. Leave empty when using filterValuesfilterValues
(TEXT, Optional): Use ONLY for ARRAY operators: in, not_in. Must be JSON array format. Leave empty when using filterValuecursor
(TEXT, Optional): The cursor for paginationlimit
(NUMBER, Optional): Number of results (1-1000)pylon.createAccountActivity
accountId
(TEXT, Required): The ID of the account to create the activity for
slug
(TEXT, Required): The slug of the activity type. Get valid slugs from ‘Get Activity Types’ actionbodyHtml
(MULTI_LINE_TEXT, Optional): Optional HTML content to display in the activitycontactId
(TEXT, Optional): Optional contact ID of the actoruserId
(TEXT, Optional): Optional user ID of the actorhappenedAt
(TEXT, Optional): Timestamp (RFC3339) when activity happened (defaults to now)link
(TEXT, Optional): Optional link to add to the activitylinkText
(TEXT, Optional): Link text to display (defaults to ‘Open link’)pylon.getActivityTypes
pylon.createAccountHighlight
accountId
(TEXT, Required): The ID of the account to create the highlight for
contentHtml
(MULTI_LINE_TEXT, Required): The HTML content for this highlightexpiresAt
(TEXT, Optional): Optional RFC3339 timestamp when highlight expirespylon.updateAccountHighlight
accountId
(TEXT, Required): The ID of the account that the highlight belongs to
highlightId
(TEXT, Required): The ID of the highlight to updatecontentHtml
(MULTI_LINE_TEXT, Optional): The updated HTML content for this highlightexpiresAt
(TEXT, Optional): Updated expiration timestamp (RFC3339)pylon.deleteAccountHighlight
accountId
(TEXT, Required): The ID of the account that the highlight belongs to
highlightId
(TEXT, Required): The ID of the highlight to deletepylon.listCustomFields
objectType
(SELECT, Required): Select the object type (account, issue, or contact)pylon.getCustomField
customFieldId
(TEXT, Required): The ID of the custom fieldpylon.createCustomField
slug
(TEXT, Required): Unique identifier for the custom field
label
(TEXT, Required): Display label for the custom fieldtype
(SELECT, Required): The type of the custom field (text, number, decimal, boolean, date, datetime, user, url, select, multiselect)objectType
(SELECT, Required): The object type this field applies to (account, issue, contact)description
(TEXT, Optional): Description of the custom fielddefaultValue
(TEXT, Optional): Default value for single-valued fieldsdefaultValues
(TEXT, Optional): Default values for multi-valued fields (JSON array)selectOptions
(TEXT, Optional): Options for select/multiselect fields (JSON array)pylon.updateCustomField
customFieldId
(TEXT, Required): The ID of the custom field to update
slug
(TEXT, Optional): Updated slug for the custom fieldlabel
(TEXT, Optional): Updated label for the custom fielddescription
(TEXT, Optional): Updated descriptiondefaultValue
(TEXT, Optional): Updated default value for single-valued fieldsdefaultValues
(TEXT, Optional): Updated default values for multi-valued fields (JSON array)selectOptions
(TEXT, Optional): Updated options for select/multiselect fields (JSON array)pylon.listUsers
cursor
(TEXT, Optional): Pagination cursor from previous request
limit
(NUMBER, Optional): Number of users to fetch (max 1000)pylon.getUser
userId
(TEXT, Required): The ID of the user to fetchpylon.updateUser
userId
(TEXT, Required): The ID of the user to update
roleId
(TEXT, Optional): The new role ID for the userstatus
(SELECT, Optional): User status (active, away, or out_of_office)pylon.searchUsers
filterField
(SELECT, Optional): Field to filter by (currently only ‘email’ is supported)
filterOperator
(SELECT, Optional): Operator for the filter (equals, in, not_in)filterValue
(TEXT, Optional): Value for equals operatorfilterValues
(TEXT, Optional): JSON array of values for in/not_in operatorscursor
(TEXT, Optional): Pagination cursor from previous requestlimit
(NUMBER, Optional): Number of users to fetch (max 1000)pylon.listKnowledgeBases
pylon.getKnowledgeBase
knowledgeBaseId
(TEXT, Required): The ID of the knowledge basepylon.createKBArticle
knowledgeBaseId
(TEXT, Required): The ID of the knowledge base. Get valid IDs from the ‘List Knowledge Bases’ action
title
(TEXT, Required): The title of the articlecontentHtml
(MULTI_LINE_TEXT, Required): The HTML content of the article (maps to body_html in API). Use proper HTML tags. Markdown will NOT be renderedcollectionId
(TEXT, Optional): The ID of the collection to add the article toslug
(TEXT, Optional): URL slug for the articleauthorUserId
(TEXT, Optional): The ID of the user to set as the article author. Get valid user IDs from the ‘List Users’ actionpublishedAt
(TEXT, Optional): Publication timestamp (RFC3339)isPublished
(SELECT, Optional): Whether the article should be published immediately (true, false)isUnlisted
(SELECT, Optional): Whether the article should be unlisted (accessible only via direct link) (true, false)pylon.updateKBArticle
articleId
(TEXT, Required): The ID of the article to update
title
(TEXT, Optional): Updated title of the articlecontentHtml
(MULTI_LINE_TEXT, Optional): Updated HTML content (maps to body_html in API). Use proper HTML tags. Markdown will NOT be renderedslug
(TEXT, Optional): Updated URL slugpublishedAt
(TEXT, Optional): Updated publication timestamp (RFC3339)pylon.listKBCollections
knowledgeBaseId
(TEXT, Required): The ID of the knowledge basepylon.createKBCollection
knowledgeBaseId
(TEXT, Required): The ID of the knowledge base
title
(TEXT, Required): The title of the collectiondescription
(TEXT, Optional): Description of the collectionslug
(TEXT, Optional): URL slug for the collectionpylon.createKBRouteRedirect
knowledgeBaseId
(TEXT, Required): The ID of the knowledge base
fromPath
(TEXT, Required): The path to redirect fromtoPath
(TEXT, Required): The path to redirect topylon.listTeams
pylon.getTeam
teamId
(TEXT, Required): The ID of the teampylon.createTeam
name
(TEXT, Required): The name of the team
description
(TEXT, Optional): Description of the teamslackChannelId
(TEXT, Optional): Associated Slack channel IDpylon.updateTeam
teamId
(TEXT, Required): The ID of the team to update
name
(TEXT, Optional): Updated name of the teamdescription
(TEXT, Optional): Updated descriptionslackChannelId
(TEXT, Optional): Updated Slack channel IDIssue | Solution |
---|---|
Authentication failed | Verify your API Key credentials |
Rate limit exceeded | Reduce request frequency |
Data not found | Check permissions and data availability |
Connection timeout | Verify network connectivity |