Skip to main content
Server path: /gist-conversations | Type: Application | PCID required: Yes

Tools

ToolDescription
gist_conversations_assign_conversationAssign or unassign a conversation
gist_conversations_create_conversationCreate a new conversation
gist_conversations_delete_conversationDelete a conversation
gist_conversations_get_conversationRetrieve a conversation
gist_conversations_get_conversation_countsGet global conversation counts
gist_conversations_get_teamRetrieve a team
gist_conversations_get_team_conversation_countsGet conversation counts by team
gist_conversations_get_teammateRetrieve a teammate
gist_conversations_get_teammate_conversation_countsGet conversation counts by teammate
gist_conversations_get_workspace_metaRetrieve workspace metadata and token info
gist_conversations_list_conversation_messagesList messages in a conversation
gist_conversations_list_conversationsList all conversations
gist_conversations_list_teammatesList all teammates
gist_conversations_list_teamsList all teams
gist_conversations_prioritize_conversationSet conversation priority
gist_conversations_reply_to_conversationReply to a conversation or add a note
gist_conversations_search_conversationsSearch conversations with filters
gist_conversations_tag_conversationTag a conversation
gist_conversations_untag_conversationRemove a tag from a conversation
gist_conversations_update_conversationUpdate a conversation (title, properties, state)

gist_conversations_assign_conversation

Assign or unassign a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
assignee_idintegerNoID of the assignee (teammate or team). Set to null to unassign.
assignee_typestringNoType of assignee (required when assigning to a team)
teammate_idintegerYesID of the teammate performing the assignment

gist_conversations_create_conversation

Create a new conversation Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesMessage body (plain text)
custom_propertiesobjectNoCustom properties
fromobjectYesSender info with id, user_id, or email
titlestringNoConversation title

gist_conversations_delete_conversation

Delete a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID

gist_conversations_get_conversation

Retrieve a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID

gist_conversations_get_conversation_counts

Get global conversation counts

gist_conversations_get_team

Retrieve a team Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam ID

gist_conversations_get_team_conversation_counts

Get conversation counts by team

gist_conversations_get_teammate

Retrieve a teammate Parameters:
ParameterTypeRequiredDefaultDescription
teammate_idstringYesTeammate ID
emailstringNoAlternative: look up by email

gist_conversations_get_teammate_conversation_counts

Get conversation counts by teammate

gist_conversations_get_workspace_meta

Retrieve workspace metadata and token info

gist_conversations_list_conversation_messages

List messages in a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
with_notesbooleanNoInclude internal notes

gist_conversations_list_conversations

List all conversations Parameters:
ParameterTypeRequiredDefaultDescription
orderstringNoSort order
order_bystringNoSort field
statusstringNoFilter by status
pageintegerNoPage number

gist_conversations_list_teammates

List all teammates Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page

gist_conversations_list_teams

List all teams Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page

gist_conversations_prioritize_conversation

Set conversation priority Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
prioritystringYesPriority level
teammate_idintegerNoTeammate ID performing the action
typestringNoSet to ‘bot’ if performed by a bot

gist_conversations_reply_to_conversation

Reply to a conversation or add a note Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
bodystringYesMessage body
fromobjectNoSender info
message_typestringYesMessage type: ‘reply’ for customer-visible reply, ‘note’ for internal note
teammate_idintegerNoTeammate ID (required when from.type=teammate)

gist_conversations_search_conversations

Search conversations with filters Parameters:
ParameterTypeRequiredDefaultDescription
orderstringNoSort order
order_bystringNoSort field
statusstringNoFilter by status
pageintegerNoPage number
filter_queryobject[]YesFilter criteria groups (groups are ANDed, criteria within a group are ORed)

gist_conversations_tag_conversation

Tag a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
message_idintegerNoMessage ID to tag (defaults to last message)
tagsstringYesComma-separated tag names

gist_conversations_untag_conversation

Remove a tag from a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
message_idintegerNoMessage ID (defaults to last message)
tag_idintegerYesTag ID to remove

gist_conversations_update_conversation

Update a conversation (title, properties, state) Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idintegerYesConversation ID
custom_propertiesobjectNoCustom properties
snoozed_untilintegerNoUnix timestamp for when to unsnooze (required when state=‘snoozed’)
statestringNoSet to ‘closed’ to close, ‘snoozed’ to snooze, ‘open’ to reopen/unsnooze
teammate_idintegerNoID of the teammate performing the action
titlestringNoConversation title
typestringNoSet to ‘bot’ if action is performed by a bot (alternative to teammate_id)