Pylon
API integration

list_all_pylon_me

Get details of the current user

list_all_pylon_users

List users in Pylon. Returns user fields: avatar_url, email, emails, id, name, role_id, and status in the response.

get_single_pylon_user_by_id

Get a user by its id in Pylon. Returns user fields: avatar_url, email, emails, id, name, role_id, and status in the response.

update_a_pylon_user_by_id

Update a user in Pylon. Requires id. Returns avatar_url, email, emails, id, name, role_id, and status for the updated user in the response.

list_all_pylon_user_roles

List all user roles in Pylon. Returns id, name, and slug fields for each user role in the response.

list_all_pylon_teams

List teams in Pylon. Returns id, name, and users (including email and id) for each team.

get_single_pylon_team_by_id

Get a team by its id in Pylon. Returns id, name, and users (including email and id) for each team.

create_a_pylon_team

Create a new team in Pylon. Returns id, name, and users fields in the response for the created team.

update_a_pylon_team_by_id

Update an existing team in Pylon using id. Returns id, name, and users array (each with email and id) in the response.

create_a_pylon_attachment

Create an attachment in Pylon. Returns id, name, description, and url of the created attachment in the response.

list_all_pylon_accounts

List accounts in Pylon. Requires limit. Returns account fields including id, name, type, created_at, domains, owner, tags, custom_fields, channels, external_ids, primary_domain, and latest_customer_activity_time in the response.

get_single_pylon_account_by_id

Get an account in Pylon by id. Returns id, name, type, created_at, domains, primary_domain, owner, channels, external_ids, tags, custom_fields, crm_settings, and latest_customer_activity_time.

create_a_pylon_account

Create an account in Pylon with the required name. Returns fields including channels, created_at, crm_settings, custom_fields, domains, external_ids, id, latest_customer_activity_time, name, owner, primary_domain, tags, and type.

update_a_pylon_account_by_id

Update an existing account in Pylon using id. Returns channels linked to the account, created_at timestamp, crm_settings details, custom_fields, domain, domains, external_ids, account id, latest_customer_activity_time, name, owner info, primary_domain, tags, and type.

delete_a_pylon_account_by_id

Delete an existing account in Pylon. Requires id. Returns request_id indicating the deletion request.

create_a_pylon_account_activity

Create a new activity for an account in Pylon. Requires id and slug. Returns success status and request_id in the response.

create_a_pylon_account_highlight

Create a new account highlight in Pylon. Requires account_id and content_html. Returns account_id, content_html, created_at, expires_at, id, and updated_at in the response.

update_a_pylon_account_highlight_by_id

Update an account highlight in Pylon. Requires account_id and id. Returns account_id, content_html, created_at, expires_at, id, and updated_at fields in the response.

delete_a_pylon_account_highlight_by_id

Delete an account highlight in Pylon. Requires account_id and id. The response includes success indicating if the operation was successful.

list_all_pylon_contacts

List all contacts in Pylon. Returns account.id, avatar_url, custom_fields, email, emails, id, name, and portal_role for each contact.

get_single_pylon_contact_by_id

Get a contact in Pylon by id. Returns fields including id, name, email, avatar_url, portal_role, account (with id), emails, and custom_fields. Requires id and limit.

create_a_pylon_contact

Create a new contact in Pylon. Requires email and name. Returns id, name, email, avatar_url, portal_role, account.id, custom_fields, and emails in the response.

update_a_pylon_contact_by_id

Update an existing contact in Pylon by id. Returns id, name, email, avatar_url, portal_role, custom_fields, emails, account.id. Requires id.

list_all_pylon_custom_fields

List custom-fields in Pylon using object_type. Returns fields such as id, label, object_type, type, slug, source, description, default_value, default_values, is_read_only, created_at, updated_at, select_metadata. Requires object_type.

get_single_pylon_custom_field_by_id

Get a custom field in Pylon by id. Returns created_at, default_value, default_values, description, id, is_read_only, label, object_type, select_metadata, slug, source, type, and updated_at in the response.

create_a_pylon_custom_field

Create a custom field in Pylon. Requires label, object_type, and type. Returns fields such as id, label, type, object_type, slug, default_value, default_values, description, select_metadata, source, created_at, updated_at, and is_read_only.

update_a_pylon_custom_field_by_id

Update a custom field in Pylon using id. Returns created_at, default_value, default_values, description, id, is_read_only, label, object_type, select_metadata, slug, source, type, and updated_at in the response.

list_all_pylon_issues

List issues in Pylon using start_time and end_time. Returns fields such as id, title, state, assignee, requester, created_at, resolution_time, csat_responses, tags, and more in the response.

get_single_pylon_issue_by_id

Get a specific issue in Pylon. Requires id. Returns fields including id, title, state, assignee, requester, created_at, body_html, tags, link, number, team, and timestamps in the response.

create_a_pylon_issue

Create a new issue in Pylon. Requires body_html and title. Returns fields such as id, title, body_html, requester, assignee, team, state, tags, created_at, latest_message_time, number, resolution_time, and type in the response.

update_a_pylon_issue_by_id

Update an existing issue in Pylon by id. Returns fields including id, assignee, body_html, created_at, custom_fields, customer_portal_visible, requester, state, tags, team, number, title, and key metrics in the response.

delete_a_pylon_issue_by_id

Delete an existing issue in Pylon. Requires id. The response returns request_id as confirmation of the operation.

pylon_issues_snooze

Snooze an issue in Pylon. Requires id and snooze_until. Returns fields such as account, assignee, body_html, created_at, state, snoozed_until_time, requester, resolution_time, tags, and type in the response.

pylon_issues_link_or_unlink

Link or unlink external issues to or from an issue in Pylon. Requires id, external_issue_id, and source. Returns fields such as id, assignee info, external_issues, state, and key timing and status fields in the response.

list_all_pylon_knowledge_bases

List all knowledge bases in Pylon. Returns id, default_language, slug, supported_languages, and title for each knowledge base in the response.

get_single_pylon_knowledge_base_by_id

Get a knowledge base in Pylon by id. Returns id, default_language, slug, supported_languages, and title in the response.

pylon_messages_redact

Redact a specific message in Pylon. Requires id and message_id. Returns author, email_info, file_urls, id, is_private, message_html, source, thread_id, and timestamp for the redacted message.

list_all_pylon_tags

List all tags in Pylon. Returns hex_color, id, object_type, and value for each tag.

get_single_pylon_tag_by_id

Get a tag in Pylon by id. Returns id, value, hex_color, and object_type fields in the response.

create_a_pylon_tag

Create a new tag in Pylon. Requires object_type and value. Returns hex_color, id, object_type, and value fields in the response.

update_a_pylon_tag_by_id

Update an existing tag in Pylon by id. Returns hex_color, id, object_type, and value for the updated tag.

delete_a_pylon_tag_by_id

Delete a tag in Pylon. Requires id. Returns request_id field indicating the request identifier in the response.

list_all_pylon_ticket_forms

List ticket-forms in Pylon. Returns id, name, slug, url, is_public, description_html, and fields (with name, slug, type, description_html) for each ticket-form.

list_all_pylon_users_search

Search users in Pylon with a required filter parameter. Returns id, email, emails, name, avatar_url, role_id, and status fields for matched users.

list_all_pylon_knowledge_base_collections

List all collections in a specific knowledge base in Pylon. Requires id. Returned fields include created_at, description, id, parent_collection_id, slug, and title for each collection.

create_a_pylon_knowledge_base_collection

Create a new knowledge-base-collections resource in Pylon using id and title. Returns id, title, description, slug, parent_collection_id, and created_at fields in the response.

create_a_pylon_knowledge_base_article

Create a new knowledge-base-article in Pylon using id, author_user_id, body_html, and title. Returns current_published_content_html, id, identifier, is_published, last_published_at, slug, title, and visibility_config fields in the response.

update_a_pylon_knowledge_base_article_by_id

Update an existing knowledge-base-articles resource in Pylon using id and article_id. Returns current_published_content_html, id, identifier, is_published, last_published_at, slug, title, and visibility_config in the response.

create_a_pylon_knowledge_base_route_redirect

Create a route redirect in Pylon knowledge base. Requires id, from_path, object_id, and object_type. Returns created_at, from_path, id, language, object_id, and object_type fields in the response.

list_all_pylon_issues_search

Search issues in Pylon using a required filter; returns issues with fields including id, state, created_at, title, requester, assignee, custom_fields, tags, and link in the response. Requires filter.

list_all_pylon_issue_followers

Get followers of an issue in Pylon. Requires id. Returns an array of follower objects with id and type fields for each follower.

create_a_pylon_issue_follower

Add or remove followers for an issue in Pylon. Requires id. Returns data with id and type of each follower and the request_id of the operation in the response.

list_all_pylon_contacts_search

Search contacts in Pylon by filter. Requires filter. Returns account.id, avatar_url, custom_fields, email, emails, id, name, and portal_role in the response.

list_all_pylon_activity_types

List custom activity types in Pylon. Returns icon_url, id, label, and slug fields for each activity type.

list_all_pylon_account_search

Search accounts in Pylon using a required filter. Returns data including id, name, domains, tags, type, created_at, owner, channels, crm_settings, external_ids, custom_fields, latest_customer_activity_time, and primary_domain for each account.