---
title: Kayako API Integration on Truto
slug: kayako
category: Helpdesk
canonical: "https://truto.one/integrations/detail/kayako/"
---

# Kayako API Integration on Truto



**Category:** Helpdesk  
**Status:** Beta

## MCP-ready AI tools

Truto exposes 345 tools for Kayako that AI agents can call directly.

- **list_all_kayako_cases** — List Kayako cases (conversations) ordered by updated_at descending. Returns: id, legacy_id, subject, portal, source_channel, last_public_channel, requester, creator, identity, assignee, assigned_agent, assigned_team, last_assigned_by, brand, status, priority, type, read_marker, sla_version, sla_metrics, form, custom_fields, last_replier, last_replier_identity, last_completed_by, last_updated_by,…
- **get_single_kayako_case_by_id** — Get a single Kayako case (conversation) by id. Returns: id, legacy_id, subject, portal, source_channel, last_public_channel, requester, creator, identity, assignee, assigned_agent, assigned_team, last_assigned_by, brand, status, priority, type, read_marker, sla_version, sla_metrics, form, custom_fields, last_replier, last_replier_identity, last_completed_by, last_updated_by, last_closed_by,…
- **create_a_kayako_case** — Create a new Kayako case (conversation). Returns the created case including id, subject, state, status, priority, requester, assigned_agent, created_at, updated_at.
- **update_a_kayako_case_by_id** — Update a Kayako case (conversation) by id. Returns the updated case including id, subject, state, status, priority, requester, assigned_agent, created_at, updated_at. Required: id.
- **kayako_cases_list_organization_cases** — List all cases (conversations) belonging to a specific organization in Kayako, ordered by updated_at descending. Returns: id, legacy_id, subject, portal, source_channel, last_public_channel, requester, creator, identity, assigned_agent, assigned_team, last_assigned_by, brand, status, priority, type, read_marker, sla_version, sla_metrics, form, custom_fields, last_replier, last_replier_identity,…
- **kayako_cases_list_channels** — Retrieve available channels for creating a new conversation in Kayako. Returns: uuid, type, character_limit, account, resource_type. Optional: user_id to filter channels by the conversation requester.
- **kayako_cases_list_reply_channels** — Retrieve available reply channels for a specific case (conversation) in Kayako. Returns: uuid, type, character_limit, account, resource_type. Required: case_id.
- **kayako_cases_list_used_channels** — List channels used in a Kayako case conversation. Returns: uuid, type, character_limit, account, resource_type. Required: case_id.
- **kayako_cases_create_reply** — Reply RESOURCE FIELDS Name Type Read-only Description posts Resources case Case Add a reply. POST /api/v1/cases/{{query.case_id}}/reply Required body params: contents, channel.
- **kayako_cases_bulk_create** — Bulk add cases. POST /api/v1/bulk/cases Required body params: cases.
- **kayako_cases_bulk_update** — Bulk update conversation. PUT /api/v1/cases
- **kayako_cases_trash** — Mark conversation as trash. PUT /api/v1/cases/{{id}}/trash
- **kayako_cases_bulk_trash** — Bulk trash conversations. PUT /api/v1/cases/trash
- **kayako_cases_empty_trash** — Empty trash. DELETE /api/v1/cases/trash
- **kayako_cases_restore** — Restore a conversations. PUT /api/v1/cases/{{id}}/restore
- **kayako_cases_list_posts** — Posts RESOURCE FIELDS Name Type Read-only Description uuid string client_id string client_id is provided by the client when creating a message. Can be used to identify messages reflected from the server back to the originating entity. This value may be null if not supplied by the client. Since this is only useful for realtime communication, older values might be erased periodically. subject string contents string creator User | Trigger | Monitor The entity that created this post. For all user actions, this will be a user resource. If triggered by automations, it will be either a monitor or trigger resource. Might be null for actions performed by the system. identity Identity For Trigger & Monitor the Identity would be null source_channel Channel Channel represents the source from which post was originally created. MAIL, HELPCENTER, TWITTER, MESSENGER, FACEBOOK, NOTE For activities the channel would be null attachments Attachments download_all string destination_medium string MAIL, MESSENGER Applicable for agent reply via MAIL channel. This value will be null for agent reply via other channels and for customer reply source string API, AGENT, MAIL, MESSENGER, MOBILE, HELPCENTER metadata array Metadata will be in key - value pair original Resource post_status string SENT, DELIVERED, REJECTED, SEEN Default: SENT post_status_reject_type string BOUNCE, BLOCKED, DROPPED, DEFERRED, EXPIRED, ERROR Note: This field applicable for REJECTED post_status post_status_reject_reason string Reject reason from MTA Note: This field applicable for REJECTED post_status post_status_updated_at timestamp ISO-8601 Format created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Shadow posts RESOURCE FIELDS Name Type Read-only Description uuid string subject string contents string creator User Original post creator (agent/customer) identity Identity Original post creator identity original_post Resource created_at timestamp ISO-8601 Format Attachments RESOURCE FIELDS Name Type Read-only Description name string size integer width integer Only if the attachment is image height integer Only if the attachment is image type string Mime-type of the file content_id string Content ID used for inline attachment alt string url string The URL to view the attachment url_download string The URL to download the attachment thumbnails Thumbnails created_at timestamp ISO-8601 Format Thumbnails RESOURCE FIELDS Name Type Read-only Description name string size integer width integer height integer type string Mime-type of the file url string The URL to view the thumbnail created_at timestamp ISO-8601 Format Email Original RESOURCE FIELDS Name Type Read-only Description id integer subject string from string to string received_at timestamp ISO-8601 Format html_content string The original html associated with the mail striped_html string The html associated with the mail with quoted text striped out source_content string Associated headers with the mail Retrieve conversation posts. GET /api/v1/cases/{{id}}/posts
- **kayako_cases_get_email_original** — Retrieve a original email. GET /api/v1/cases/posts/{{id}}/email_original
- **get_single_kayako_case_post_by_id** — Get a single Kayako case post (conversation message or note) by id. Returns: id, uuid, subject, contents, creator, post_status, created_at, updated_at. Required: id.
- **update_a_kayako_case_post_by_id** — Update a post in a Kayako conversation by id, typically to set its delivery status. Returns: id, created_at, updated_at. Required: id. When post_status is set to SEEN, all preceding posts are also marked as SEEN.
- **list_all_kayako_case_notes** — List notes for a Kayako case, including notes on the conversation, its requester, and requester's organization. Returns: id, body_text, body_html, is_pinned, pinned_by, user, attachments, download_all, created_at, updated_at, resource_type, resource_url. Required: case_id.
- **get_single_kayako_case_note_by_id** — Get a single Kayako case note by id. Returns: id, body_text, body_html, is_pinned, pinned_by, user, attachments, download_all, created_at, updated_at, resource_type, resource_url. Required: case_id, id.
- **update_a_kayako_case_note_by_id** — Update a Kayako case note, typically to pin or unpin it in the conversation timeline. Returns: id, body_text, body_html, is_pinned, pinned_by, user, attachments, download_all, created_at, updated_at, resource_type, resource_url. Required: case_id, id.
- **list_all_kayako_case_tags** — List all tags attached to a Kayako case, ordered by created_at ascending. Returns: id, name, resource_type. Required: case_id.
- **kayako_case_tags_add** — Add tags to a Kayako case by supplying a comma-separated string. Returns the updated list of tags including id, name, and resource_type. Required: case_id.
- **kayako_case_tags_replace** — Replace all tags on a Kayako case with a new set of comma-separated tags. Returns the updated list of tags including id, name, and resource_type. Required: case_id.
- **kayako_case_tags_remove** — Remove specified tags from a Kayako case by supplying a comma-separated string. Returns the remaining tags including id, name, and resource_type. Required: case_id.
- **list_all_kayako_case_statuses** — List all case statuses in Kayako. Returns: id, label, type, sort_order, is_sla_active, is_deleted, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_case_status_by_id** — Get a single Kayako case status by id. Returns: id, label, type, sort_order, is_sla_active, is_deleted, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_case_status** — Create a new case status in Kayako. Returns: id, label, type, sort_order, is_sla_active, is_deleted, created_at, updated_at, resource_type, resource_url.
- **update_a_kayako_case_status_by_id** — Update an existing Kayako case status by id. Returns: id, label, type, sort_order, is_sla_active, is_deleted, created_at, updated_at, resource_type, resource_url. Required: id.
- **kayako_case_statuses_reorder** — Reorder custom case statuses in Kayako by passing the status IDs in the desired order. Returns an empty response on success.
- **delete_a_kayako_case_status_by_id** — Delete a Kayako case status by id. Deleting a status also removes it from conversations and macros. Returns an empty response on success. Required: id.
- **kayako_case_statuses_bulk_delete** — Bulk delete multiple Kayako case statuses by comma-separated ids. Deleting a status also removes it from conversations and macros. Returns an empty response on success. Required: ids.
- **list_all_kayako_case_priorities** — List all case priorities in Kayako. Returns: id, label, level, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_case_priority_by_id** — Get a single case priority by id in Kayako. Returns: id, label, level, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_case_priority** — Create a new case priority in Kayako. Returns the created priority object including id, label, level, created_at, updated_at, resource_type, and resource_url.
- **update_a_kayako_case_priority_by_id** — Update an existing case priority by id in Kayako. Returns the updated priority object including id, label, level, created_at, updated_at, resource_type, and resource_url. Required: id.
- **kayako_case_priorities_reorder** — Reorder case priorities in Kayako by specifying priority ids in the desired order. Returns no data body on success. Required: priority_ids.
- **delete_a_kayako_case_priority_by_id** — Delete a Kayako case priority by id. Deleting a priority also removes it from conversations and macros. Returns an empty response on success. Required: id.
- **kayako_case_priorities_bulk_delete** — Bulk delete multiple Kayako case priorities by comma-separated ids. Returns an empty response on success. Required: ids.
- **list_all_kayako_case_types** — List all case types in Kayako. Returns: id, label, type, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_case_type_by_id** — Get a single Kayako case type by id. Returns: id, label, type, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_case_type** — Create a new case type in Kayako with a label. Returns: id, label, type, created_at, updated_at, resource_type, resource_url.
- **update_a_kayako_case_type_by_id** — Update a Kayako case type by id, typically to change its label. Returns: id, label, type, created_at, updated_at, resource_type, resource_url. Required: id.
- **delete_a_kayako_case_type_by_id** — Delete a Kayako case type by id. Returns an empty 204 response on success. Deleting a case type removes it from conversations and macros. Required: id.
- **kayako_case_types_bulk_delete** — Bulk delete Kayako case types by providing comma-separated ids. Returns: id, label, created_at, updated_at, resource_type, resource_url. Required: ids. Deleting a type also removes it from conversations and macros.
- **list_all_kayako_case_activities** — List activities for a specific Kayako case ordered by created_at (ascending). Returns: id, activity, actor, verb, summary, actions, object, object_actor, location, place, target, result, in_reply_to, participant, portal, weight, ip_address, created_at, resource_type. Required: case_id.
- **list_all_kayako_users** — Retrieve all users. GET /api/v1/users
- **get_single_kayako_user_by_id** — Retrieve a user. GET /api/v1/users/{{id}}
- **create_a_kayako_user** — Add a user. POST /api/v1/users Required body params: role_id, full_name.
- **update_a_kayako_user_by_id** — Update a user. PUT /api/v1/users/{{id}}
- **delete_a_kayako_user_by_id** — Delete a user. DELETE /api/v1/users/{{id}}
- **kayako_users_bulk_create** — Bulk add users. POST /api/v1/bulk/users Required body params: users.
- **kayako_users_filter** — Autocomplete Autocomplete Name Type Read-only Description users.organizationid Organization Retrieve smart lists of users. POST /api/v1/users/filter Required body params: predicates.
- **kayako_users_list_definitions** — Propositions RESOURCE FIELDS Name Type Read-only Description label string field string Field name on which the rules will be applied type string NUMERIC, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, DATE_RELATIVE sub_type string Depends on type: NUMERIC: FLOAT, INTEGER DATE_RELATIVE: PAST, PAST_OR_PRESENT, PRESENT, PAST_OR_FUTURE, FUTURE group string DATE for type DATE_ABSOLUTE, DATE_RELATIVE input_type string INTEGER, FLOAT, STRING, BOOLEAN, OPTIONS, MULTIPLE, TAGS, DATE_ABSOLUTE, DATE_RELATIVE, AUTOCOMPLETE operators array Depends on input_type: INTEGER, FLOAT: comparison_equalto, comparison_greaterthan, comparison_lessthan STRING: string_contains_insensitive, comparison_equalto, comparison_not_equalto BOOLEAN: comparison_equalto, comparison_not_equalto OPTIONS: comparison_equalto, comparison_not_equalto TAGS: collection_contains_insensitive, collection_contains_any_insensitive, collection_does_not_contain_insensitive DATE_ABSOLUTE: date_is, date_is_not DATE_RELATIVE: date_after_or_on, date_before_or_on AUTOCOMPLETE: comparison_equalto, comparison_not_equalto values mixed Input type: OPTIONS {"1":"Kayako", "2":"Subscription"} Input type: INTEGER, FLOAT, BOOLEAN, TAGS, STRING, DATE_ABSOLUTE or TIME value n/a Input type: MULTIPLE {"1":"Kayako", "2":"Subscription"} Input type: RELATIVE {"today":"today", "currentweek":"currentweek", "currentmonth":"currentmonth"} Input type: AUTOCOMPLETE AUTOCOMPLETE Retrieve all definitions. GET /api/v1/users/definitions
- **kayako_users_list_cases** — Retrieve user conversations. GET /api/v1/users/{{query.user_id}}/cases
- **kayako_users_bulk_delete** — Delete users. DELETE /api/v1/users
- **kayako_users_invite** — Send invitation with details. POST /api/v1/users/invite Required body params: users.
- **kayako_users_bulk_update** — Update users. PUT /api/v1/users
- **kayako_users_update_password** — Update a password. PUT /api/v1/users/{{id}}/password Required body params: new_password.
- **kayako_users_reset_password** — Reset password. POST /api/v1/password/reset Required body params: email.
- **kayako_users_list_posts** — Posts RESOURCE FIELDS Name Type Read-only Description uuid string sequence integer subject string contents string creator User identity Identity source_channel Channel attachments Attachments download_all string original Resource created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Attachments RESOURCE FIELDS Name Type Read-only Description name string size integer width integer Only if the attachment is image height integer Only if the attachment is image type string Mime-type of the file content_id string Content ID used for inline attachment alt string url string The URL to view the attachment url_download string The URL to download the attachment thumbnails Thumbnails created_at timestamp ISO-8601 Format Thumbnails RESOURCE FIELDS Name Type Read-only Description name string size integer width integer height integer type string Mime-type of the file url string The URL to view the thumbnail created_at timestamp ISO-8601 Format Retrieve user posts. GET /api/v1/users/{{query.user_id}}/posts
- **kayako_users_get_post** — Retrieve a post. GET /api/v1/users/posts/{{id}}
- **list_all_kayako_identity_emails** — List email identities for a Kayako user, ordered by is_primary then updated_at descending. Returns: id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url. Required: user_id.
- **get_single_kayako_identity_email_by_id** — Get a single email identity in Kayako by id. Returns: id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_identity_email** — Add a new email identity for a Kayako user. Returns: id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url. Required: user_id, email.
- **update_a_kayako_identity_email_by_id** — Update an existing email identity in Kayako by id. Returns: id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url. Required: id.
- **kayako_identity_emails_send_verification_email** — Send a verification email for a Kayako email identity by email_id. Returns: notifications, id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url. Required: email_id.
- **delete_a_kayako_identity_email_by_id** — Delete a Kayako email identity by id. Returns an empty 204 response on success. Required: id.
- **kayako_identity_emails_bulk_delete** — Delete multiple Kayako email identities in bulk by providing comma-separated ids. Returns an empty 204 response on success. Required: ids.
- **list_all_kayako_identity_phones** — List all phone identities for a user in Kayako, ordered by is_primary then updated_at descending. Returns: id, number, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled.
- **get_single_kayako_identity_phone_by_id** — Get a single phone identity by id in Kayako. Returns: id, number, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled. Required: id.
- **create_a_kayako_identity_phone** — Add a phone identity to a user in Kayako. Returns the created phone identity including id, number, is_primary, is_validated, created_at, updated_at, resource_type, and resource_url.
- **update_a_kayako_identity_phone_by_id** — Update a phone identity in Kayako by modifying is_primary or is_validated flags. Returns: id, number, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled. Required: id.
- **delete_a_kayako_identity_phone_by_id** — Delete a phone identity by id in Kayako. Returns an empty 204 response on success. Required: id.
- **kayako_identity_phones_bulk_delete** — Bulk delete phone identities in Kayako by providing comma-separated IDs. Returns an empty 204 response on success. Required: ids.
- **list_all_kayako_identity_twitter** — List all Twitter identity accounts for Kayako users, ordered by is_primary then updated_at descending. Returns: id, twitter_id, full_name, screen_name, follower_count, description, url, location, profile_image_url, locale, is_verified, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled.
- **get_single_kayako_identity_twitter_by_id** — Get a single Twitter identity account in Kayako by id. Returns: id, twitter_id, full_name, screen_name, follower_count, description, url, location, profile_image_url, locale, is_verified, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled. Required: id.
- **create_a_kayako_identity_twitter** — Add a Twitter identity account for a Kayako user by providing the Twitter screen name. Returns: id, twitter_id, full_name, screen_name, follower_count, description, url, location, profile_image_url, locale, is_verified, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled.
- **update_a_kayako_identity_twitter_by_id** — Update a Twitter identity account in Kayako by id, typically to change primary or validation status. Returns: id, twitter_id, full_name, screen_name, follower_count, description, url, location, profile_image_url, locale, is_verified, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, email, is_notification_enabled. Required: id.
- **delete_a_kayako_identity_twitter_by_id** — Delete a Twitter identity account in Kayako by id. Returns an empty 204 response on success. Required: id.
- **kayako_identity_twitter_bulk_delete** — Bulk delete Twitter identity accounts in Kayako by providing comma-separated ids. Returns: total_count, id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url. Required: ids.
- **list_all_kayako_identity_facebook** — List all Facebook identity accounts in Kayako, optionally filtered by user. Returns: id, email, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, is_notification_enabled.
- **get_single_kayako_identity_facebook_by_id** — Get a single Facebook identity account by id. Returns: id, email, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, is_notification_enabled. Required: id.
- **update_a_kayako_identity_facebook_by_id** — Update a Facebook identity account in Kayako. Returns: id, facebook_id, user_name, full_name, email, bio, birth_date, website, profile_url, locale, is_verified, is_primary, is_validated, created_at, updated_at, resource_type, resource_url, is_notification_enabled. Required: id.
- **delete_a_kayako_identity_facebook_by_id** — Delete a Facebook identity account by id. Returns an empty 204 response on success.
- **kayako_identity_facebook_bulk_delete** — Bulk delete multiple Facebook identity accounts in Kayako by specifying comma-separated ids. Returns: total_count, id, email, is_primary, is_validated, is_notification_enabled, created_at, updated_at, resource_type, resource_url.
- **list_all_kayako_organizations** — Retrieve all organizations. GET /api/v1/organizations
- **get_single_kayako_organization_by_id** — Retrieve an organization. GET /api/v1/organizations/{{id}}
- **create_a_kayako_organization** — Add an organization. POST /api/v1/organizations
- **kayako_organizations_bulk_create** — Bulk add organizations. POST /api/v1/bulk/organizations Required body params: organizations.
- **update_a_kayako_organization_by_id** — Update an organization. PUT /api/v1/organizations/{{id}}
- **delete_a_kayako_organization_by_id** — Delete an organization. DELETE /api/v1/organizations/{{id}}
- **kayako_organizations_filter** — Retrieve smart lists of organizations. POST /api/v1/organizations/filter Required body params: predicates.
- **kayako_organizations_list_definitions** — Propositions RESOURCE FIELDS Name Type Read-only Description label string field string Field name on which the rules will be applied type string NUMERIC, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, DATE_RELATIVE sub_type string Depends on type: NUMERIC: FLOAT, INTEGER DATE_RELATIVE: PAST, PAST_OR_PRESENT, PRESENT, PAST_OR_FUTURE, FUTURE group string DATE for type DATE_ABSOLUTE, DATE_RELATIVE input_type string INTEGER, FLOAT, STRING, BOOLEAN, OPTIONS, MULTIPLE, TAGS, DATE_ABSOLUTE, DATE_RELATIVE, AUTOCOMPLETE operators array Depends on input_type: INTEGER, FLOAT: comparison_equalto, comparison_greaterthan, comparison_lessthan STRING: string_contains_insensitive, comparison_equalto, comparison_not_equalto BOOLEAN: comparison_equalto, comparison_not_equalto OPTIONS: comparison_equalto, comparison_not_equalto TAGS: collection_contains_insensitive, collection_contains_any_insensitive, collection_does_not_contain_insensitive DATE_ABSOLUTE: date_is, date_is_not DATE_RELATIVE: date_after_or_on, date_before_or_on values mixed Input type: OPTIONS {"1":"Kayako", "2":"Subscription"} Input type: INTEGER, FLOAT, BOOLEAN, TAGS, STRING, DATE_ABSOLUTE or TIME value n/a Input type: MULTIPLE {"1":"Kayako", "2":"Subscription"} Input type: RELATIVE {"today":"today", "currentweek":"currentweek", "currentmonth":"currentmonth"} Retrieve all definitions. GET /api/v1/organizations/definitions
- **kayako_organizations_list_members** — Retrieve members. GET /api/v1/organizations/{{query.organization_id}}/members
- **kayako_organizations_list_posts** — Posts RESOURCE FIELDS Name Type Read-only Description uuid string sequence integer subject string contents string creator User identity Identity source_channel Channel attachments Attachments download_all string original Resource created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Attachments RESOURCE FIELDS Name Type Read-only Description name string size integer width integer Only if the attachment is image height integer Only if the attachment is image type string Mime-type of the file content_id string Content ID used for inline attachment alt string url string The URL to view the attachment url_download string The URL to download the attachment thumbnails Thumbnails created_at timestamp ISO-8601 Format Thumbnails RESOURCE FIELDS Name Type Read-only Description name string size integer width integer height integer type string Mime-type of the file url string The URL to view the thumbnail created_at timestamp ISO-8601 Format Retrieve organization posts. GET /api/v1/organizations/{{query.organization_id}}/posts
- **kayako_organizations_get_post** — Retrieve a post. GET /api/v1/organizations/posts/{{query.post_id}}
- **kayako_organizations_list_tags** — Tags RESOURCE FIELDS Name Type Read-only Description name string Retrieve all tags. GET /api/v1/organizations/{{query.organization_id}}/tags
- **kayako_organizations_add_tags** — Add tags. POST /api/v1/organizations/{{query.organization_id}}/tags Required body params: tags.
- **kayako_organizations_remove_tags** — Remove tags. DELETE /api/v1/organizations/{{query.organization_id}}/tags
- **kayako_organizations_bulk_delete** — Delete organizations. DELETE /api/v1/organizations
- **kayako_organizations_bulk_update** — Update organizations. PUT /api/v1/organizations Required body params: is_shared.
- **kayako_organizations_list_fields** — Fields RESOURCE FIELDS Name Type Read-only Description fielduuid string title string type string TEXT, TEXTAREA, CHECKBOX, RADIO, SELECT, DATE, FILE, NUMERIC, DECIMAL, YESNO, CASCADINGSELECT, REGEX key string is_visible_to_customers boolean Default: false customer_titles Field Locales is_customer_editable boolean Default: false is_required_for_customers boolean Default: false descriptions Field Locales regular_expression string The validation pattern for a field value to be deemed valid sort_order integer Ordering of the field relative to other fields is_enabled boolean Default: true options Field Options This can be set for fields of type CHECKBOX, RADIO, SELECT, CASCADINGSELECT created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Retrieve all fields. GET /api/v1/organizations/fields
- **kayako_organizations_get_field** — Retrieve a field. GET /api/v1/organizations/fields/{{id}}
- **kayako_organizations_create_field** — Add a field. POST /api/v1/organizations/fields Required body params: type, title.
- **kayako_organizations_update_field** — Update a field. PUT /api/v1/organizations/fields/{{id}}
- **kayako_organizations_delete_field** — Delete a field. DELETE /api/v1/organizations/fields/{{id}}
- **kayako_organizations_bulk_delete_fields** — Delete fields. DELETE /api/v1/organization/fields
- **kayako_organizations_delete_field_option** — Delete a field option. DELETE /api/v1/organizations/fields/{{query.field_id}}/options/{{id}}
- **kayako_organizations_bulk_delete_field_options** — Delete field options. DELETE /api/v1/organizations/fields/{{query.field_id}}/options
- **kayako_organizations_list_field_values** — Fields values RESOURCE FIELDS Name Type Read-only Description field Fields value mixed Retrieve field values. GET /api/v1/organizations/{{query.organization_id}}/field/values
- **kayako_organizations_update_field_values** — Update field values. PUT /api/v1/organizations/{{query.organization_id}}/field/values Required body params: field_values.
- **kayako_organizations_list_activities** — Activities RESOURCE FIELDS Name Type Read-only Description activity string An identifier for the activity. create_organization, update_organization etc. Should contain a-Z and underscore. actor Actor Who did it. The user/system that carried out this activity verb string What they did. CREATE, SHARE, JOIN, LIKE, NOTIFY etc. summary string actions Actions object Object Activity performed on. Case, Team, Event etc. object_actor Actor If this activity's object is itself another activity, this property specifies the original activity's actor location Location place Place Where the activity was carried out target Target Describes object targeted by activity result Result Describes the result of the activity in_reply_to In Reply To Identifying an object which can be considered as a response to the base object participant string Describes participant of the activity portal string weight float Weight decides the priority/importance of this activity ip_address string created_at timestamp ISO-8601 Format Actions RESOURCE FIELDS Name Type Read-only Description action string CREATED, UPDATED, DELETED field string old_value string new_value string old_object Resource new_object Resource Actor RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource Object RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource Place RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource Target RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource Result RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource InReplyTo RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource Participant RESOURCE FIELDS Name Type Read-only Description name string titile string prefix string url string full_title string image string preposition string original Resource Location RESOURCE FIELDS Name Type Read-only Description city string region string region_code string area_code string time_zone string organization string net_speed string The network speed associated with the IP address. country string country_code string postal_code string latitude string longitude string metro_code string The metro code associated with the IP address. These are only available for IP addresses in the US. isp string The name of the Internet Service Provider associated with the IP address. Retrieve all activities. GET /api/v1/organizations/{{query.organization_id}}/activities
- **kayako_organizations_list_domains** — Domains RESOURCE FIELDS Name Type Read-only Description domain string is_primary boolean This returns true for the primary domain of the user Default: false is_validated boolean Specifies if the domain is validated Default: false created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Retrieve all domains. GET /api/v1/identities/domains
- **kayako_organizations_get_domain** — Retrieve a domain. GET /api/v1/identities/domains/{{id}}
- **kayako_organizations_create_domain** — Add a domain. POST /api/v1/identities/domains Required body params: organization_id, domain.
- **kayako_organizations_update_domain** — Update a domain. PUT /api/v1/identities/domains/{{id}}
- **kayako_organizations_delete_domain** — Delete domain. DELETE /api/v1/identities/domains/{{id}}
- **kayako_organizations_bulk_delete_domains** — Delete domains. DELETE /api/v1/identities/domains
- **kayako_organizations_list_notes** — Notes RESOURCE FIELDS Name Type Read-only Description body_text string body_html string is_pinned boolean Default: false pinned_by User user User attachments Attachments download_all string Download all attachment as zip created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Attachments RESOURCE FIELDS Name Type Read-only Description name string size integer width integer Only if the attachment is image height integer Only if the attachment is image type string Mime-type of the file content_id string Content ID used for inline attachment alt string url string The URL to view the attachment url_download string The URL to download the attachment thumbnails Thumbnails created_at timestamp ISO-8601 Format Thumbnails RESOURCE FIELDS Name Type Read-only Description name string size integer width integer height integer type string Mime-type of the file url string The URL to view the thumbnail created_at timestamp ISO-8601 Format Retrieve all notes. GET /api/v1/organizations/{{query.organization_id}}/notes
- **kayako_organizations_get_note** — Retrieve a note. GET /api/v1/organizations/{{query.organization_id}}/notes/{{id}}
- **kayako_organizations_create_note** — Add a note. POST /api/v1/organizations/{{query.organization_id}}/notes Required body params: contents.
- **kayako_organizations_update_note** — Update a note. PUT /api/v1/organizations/{{query.organization_id}}/notes/{{id}} Required body params: is_pinned.
- **kayako_organizations_replace_tags** — Replace tags. PUT /api/v1/organizations/{{query.organization_id}}/tags Required body params: tags.
- **kayako_organizations_reorder_fields** — Reorder fields. PUT /api/v1/organizations/fields/reorder Required body params: field_ids.
- **kayako_organizations_reorder_field_options** — Fields options RESOURCE FIELDS Name Type Read-only Description fielduuid string values Field Locales sort_order integer created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Reorder field options. PUT /api/v1/organizations/fields/{{query.field_id}}/options/reorder Required body params: option_ids.
- **list_all_kayako_roles** — Retrieve all roles. GET /api/v1/roles
- **get_single_kayako_role_by_id** — Retrieve a role. GET /api/v1/roles/{{id}}
- **create_a_kayako_role** — Add a role. POST /api/v1/roles Required body params: title.
- **update_a_kayako_role_by_id** — Update a role. PUT /api/v1/roles/{{id}}
- **delete_a_kayako_role_by_id** — Delete a role. DELETE /api/v1/roles/{{id}}
- **kayako_roles_bulk_delete** — Delete roles. DELETE /api/v1/roles Required body params: ids.
- **kayako_roles_list_permissions** — Permissions RESOURCE FIELDS Name Type Read-only Description name string value boolean created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Retrieve all permissions. GET /api/v1/roles/{{id}}/permissions
- **kayako_roles_update_permissions** — Update permissions. PUT /api/v1/roles/{{id}}/permissions Required body params: permission.
- **list_all_kayako_teams** — List all teams in Kayako ordered by id ascending. Returns: id, legacy_id, title, businesshour, member_count, created_at, updated_at, resource_type, resource_url. Supports filtering by legacy_ids.
- **get_single_kayako_team_by_id** — Get a single Kayako team by id. Returns the team object including id, title, member_count, businesshour, created_at, updated_at, resource_type, and resource_url. Required: id.
- **create_a_kayako_team** — Create a new team in Kayako. Returns the created team object including id, title, member_count, businesshour, created_at, updated_at, resource_type, and resource_url.
- **update_a_kayako_team_by_id** — Update a Kayako team by id. Returns the updated team object including id, title, member_count, businesshour, created_at, updated_at, resource_type, and resource_url. Required: id.
- **delete_a_kayako_team_by_id** — Delete a Kayako team by id. Returns an empty 204 response on success. Required: id.
- **kayako_teams_list_availability** — Retrieve available teams. GET /api/v1/teams/availability
- **kayako_teams_bulk_create** — Bulk add teams. POST /api/v1/bulk/teams Required body params: teams.
- **kayako_teams_bulk_delete** — Delete teams. DELETE /api/v1/teams
- **kayako_teams_list_members** — Retrieve all members. GET /api/v1/teams/{{id}}/members
- **kayako_teams_add_members** — Add a member. POST /api/v1/teams/{{id}}/members Required body params: agent_ids.
- **kayako_teams_remove_members** — Delete a member. DELETE /api/v1/teams/{{id}}/members
- **list_all_kayako_user_activities** — List activities for a Kayako user, ordered by created_at descending. Returns: id, activity, actor, verb, summary, actions, object, object_actor, location, place, target, result, in_reply_to, participant, portal, weight, ip_address, created_at, resource_type. Required: user_id.
- **list_all_kayako_user_notes** — List notes for a Kayako user, including notes on the user's organization. Returns: id, body_text, body_html, is_pinned, pinned_by, user, attachments, download_all, created_at, updated_at, resource_type, resource_url. Required: user_id. Ordered by created_at descending.
- **kayako_user_notes_get_note** — Retreive a note. GET /api/v1/users/{{query.user_id}}/notes/{{id}}
- **kayako_user_notes_create_note** — Add a note. POST /api/v1/users/{{query.user_id}}/notes Required body params: contents.
- **kayako_user_notes_update_note** — Update a note. PUT /api/v1/users/{{query.user_id}}/notes/{{id}} Required body params: is_pinned.
- **list_all_kayako_articles** — List Kayako help center articles, optionally filtered by section, tags, status, or legacy ids. Returns: id, contents, status, created_at, updated_at, resource_type, resource_url, is_html, user, replies, is_liked, like_count. Filter by section_id, tags, filter, or legacy_ids.
- **get_single_kayako_article_by_id** — Get a single Kayako help center article by id. Returns: id, contents, status, created_at, updated_at, resource_type, resource_url, is_html, user, replies, is_liked, like_count. Required: id.
- **kayako_articles_list_popular** — List popular Kayako help center articles for a given category. Returns: id, legacy_id, uuid, titles, slugs, contents, keywords, section, creator, author, attachments, download_all, status, upvote_count, downvote_count, views, rank, tags, is_featured, allow_comments, total_comments, created_at, published_at, updated_at, helpcenter_url, resource_type, resource_url, is_html, user, replies, is_liked,…
- **kayako_articles_list_related** — List articles related to a given Kayako help center article. Returns: id, legacy_id, uuid, titles, slugs, contents, keywords, section, creator, author, attachments, download_all, status, upvote_count, downvote_count, views, rank, tags, is_featured, allow_comments, total_comments, created_at, published_at, updated_at, helpcenter_url, resource_type, resource_url, is_html, user, replies, is_liked,…
- **create_a_kayako_article** — Create a new Kayako help center article. Returns the created article including id, uuid, status, titles, contents, section, author, created_at, helpcenter_url. Collaborators can only create articles with DRAFT status.
- **kayako_articles_bulk_create** — Bulk create up to 200 Kayako help center articles at once. Returns a bulk job with id, status, created_at, updated_at, resource_type, and resource_url for tracking the import. Required: articles. Max 200 articles per batch; set partial_import to true to insert valid records even when some fail validation.
- **update_a_kayako_article_by_id** — Update a single Kayako help center article by id. Returns the full article object including id, uuid, titles, contents, status, section, author, created_at, and updated_at. Required: id.
- **kayako_articles_reorder** — Reorder articles within a Kayako help center section by passing article ids in the desired order. Returns a 200 response confirming the reorder. Required: article_ids, section_id.
- **delete_a_kayako_article_by_id** — Delete a Kayako help center article by id. Returns an empty 200 response on success. Required: id.
- **kayako_articles_search** — Search Kayako help center articles by query string. Returns matching articles with id, uuid, status, titles, contents, section, created_at, helpcenter_url, and more. Query must be more than 3 characters.
- **kayako_articles_bulk_delete** — Bulk delete multiple Kayako help center articles by comma-separated ids. Returns: total_count, id, contents, is_html, status, user, replies, is_liked, like_count, created_at, updated_at, resource_type, resource_url. Required: ids.
- **kayako_articles_bulk_update** — Update multiple Kayako help center articles at once by specifying comma-separated ids. Returns a 200 response confirming the update. Required: ids.
- **list_all_kayako_article_votes** — Votes RESOURCE FIELDS Name Type Read-only Description type string HELPFUL, NOT_HELPFUL user User created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Retrieve all votes. GET /api/v1/articles/{{query.article_id}}/votes
- **get_single_kayako_article_vote_by_id** — Retrieve a vote. GET /api/v1/articles/{{query.article_id}}/votes/{{id}}
- **kayako_article_votes_check_voted** — Retrieve vote status. GET /api/v1/articles/{{query.article_id}}/hasvoted
- **kayako_article_votes_vote_helpful** — Vote as helpful. POST /api/v1/articles/{{query.article_id}}/votes/helpful
- **kayako_article_votes_vote_not_helpful** — Vote as not helpful. POST /api/v1/articles/{{query.article_id}}/votes/nothelpful
- **delete_a_kayako_article_vote_by_id** — Delete a vote. DELETE /api/v1/articles/{{query.article_id}}/votes/{{id}}
- **kayako_article_votes_bulk_delete** — Delete votes. DELETE /api/v1/articles/{{query.article_id}}/votes
- **list_all_kayako_article_attachments** — Attachments RESOURCE FIELDS Name Type Read-only Description name string size integer width integer Only if the attachment is image height integer Only if the attachment is image type string Mime-type of the file content_id string Content ID used for inline attachment alt string url string The URL to view the attachment url_download string The URL to download the attachment thumbnails Thumbnails created_at timestamp ISO-8601 Format Thumbnails RESOURCE FIELDS Name Type Read-only Description name string size integer width integer height integer type string Mime-type of the file url string The URL to view the thumbnail created_at timestamp ISO-8601 Format Retrieve all article's attachments. GET /api/v1/articles/{{query.article_id}}/attachments
- **delete_a_kayako_article_attachment_by_id** — Delete an attachment. DELETE /api/v1/articles/{{query.article_id}}/attachments/{{id}}
- **list_all_kayako_categories** — Retrieve all categories. GET /api/v1/categories
- **get_single_kayako_category_by_id** — Retrieve a category. GET /api/v1/categories/{{id}}
- **create_a_kayako_category** — Add a category. POST /api/v1/categories Required body params: titles.
- **update_a_kayako_category_by_id** — Update a category. PUT /api/v1/categories/{{id}}
- **delete_a_kayako_category_by_id** — Delete a category. DELETE /api/v1/categories/{{id}}
- **kayako_categories_bulk_create** — Bulk add categories. POST /api/v1/bulk/categories Required body params: categories.
- **kayako_categories_bulk_update** — Update categories. PUT /api/v1/categories
- **kayako_categories_reorder** — Reorder categories. PUT /api/v1/categories/reorder Required body params: category_ids.
- **kayako_categories_bulk_delete** — Delete categories. DELETE /api/v1/categories
- **list_all_kayako_sections** — Retrieve all sections. GET /api/v1/sections
- **get_single_kayako_section_by_id** — Retrieve a section. GET /api/v1/sections/{{id}}
- **create_a_kayako_section** — Add a section. POST /api/v1/sections Required body params: titles, category_id.
- **update_a_kayako_section_by_id** — Update a section. PUT /api/v1/sections/{{id}}
- **delete_a_kayako_section_by_id** — Delete a section. DELETE /api/v1/sections/{{id}}
- **kayako_sections_bulk_create** — Bulk add sections. POST /api/v1/bulk/sections Required body params: sections.
- **kayako_sections_bulk_update** — Update sections. PUT /api/v1/sections
- **kayako_sections_bulk_delete** — Delete sections. DELETE /api/v1/sections
- **kayako_sections_reorder** — Reorder Sections. PUT /api/v1/sections/reorder Required body params: section_ids.
- **list_all_kayako_mailboxes** — Retrieve all mailboxes. GET /api/v1/mailboxes
- **get_single_kayako_mailbox_by_id** — Retrieve a mailbox. GET /api/v1/mailboxes/{{id}}
- **kayako_mailboxes_get_configuration** — Retrieve mailbox configuration. GET /api/v1/mailboxes/{{query.mailbox_id}}/configuration
- **create_a_kayako_mailbox** — Add a mailbox. POST /api/v1/mailboxes Required body params: address.
- **update_a_kayako_mailbox_by_id** — Update a mailbox. PUT /api/v1/mailboxes/{{id}}
- **kayako_mailboxes_mark_default** — Mark as default. PUT /api/v1/mailboxes/default Required body params: mailbox_id.
- **delete_a_kayako_mailbox_by_id** — Delete a mailbox. DELETE /api/v1/mailboxes/{{id}}
- **kayako_mailboxes_bulk_delete** — Delete mailboxes. DELETE /api/v1/mailboxes
- **kayako_mailboxes_bulk_update** — Update mailboxes. PUT /api/v1/mailboxes Required body params: is_enabled.
- **kayako_search_search** — Unified search. GET /api/v1/search
- **list_all_kayako_brands** — Retrieve all brands. GET /api/v1/brands
- **get_single_kayako_brand_by_id** — Retrieve a brand. GET /api/v1/brands/{{id}}
- **create_a_kayako_brand** — Add a brand. POST /api/v1/brands Required body params: sub_domain, locale_id.
- **update_a_kayako_brand_by_id** — Update a brand. PUT /api/v1/brands/{{id}}
- **delete_a_kayako_brand_by_id** — Delete a brand. DELETE /api/v1/brands/{{id}}
- **kayako_brands_check_available** — Check domain availability. POST /api/v1/brands/available Required body params: sub_domain.
- **kayako_brands_validate** — Validate alias. POST /api/v1/brands/validate Required body params: sub_domain, alias.
- **kayako_brands_get_certificate** — Get SSL Certificate. GET /api/v1/brands/{{query.brand_id}}/certificate
- **kayako_brands_bulk_update** — Mass action on brands. PUT /api/v1/brands Required body params: is_enabled.
- **kayako_brands_bulk_delete** — Delete brands. DELETE /api/v1/brands
- **kayako_autocomplete_list_emails** — Emails RESOURCE FIELDS Name Type Read-only Description identity Email parent Resource Lookup emails. GET /api/v1/autocomplete/emails
- **kayako_autocomplete_list_tags** — Tags RESOURCE FIELDS Name Type Read-only Description tags string Lookup tags. GET /api/v1/autocomplete/tags
- **kayako_autocomplete_list_organizations** — Organizations RESOURCE FIELDS Name Type Read-only Description organization Organization Lookup organizations. GET /api/v1/autocomplete/organizations
- **kayako_autocomplete_list_users** — Users RESOURCE FIELDS Name Type Read-only Description user User Lookup users. GET /api/v1/autocomplete/users
- **list_all_kayako_files** — Retrieve all files. GET /api/v1/files
- **get_single_kayako_file_by_id** — Retrieve a file. GET /api/v1/files/{{id}}
- **create_a_kayako_file** — Add a file. POST /api/v1/files Required body params: content.
- **delete_a_kayako_file_by_id** — Delete a file. DELETE /api/v1/files/{{id}}
- **kayako_files_get_content** — Download a file. GET /api/v1/files/{{query.file_id}}/content
- **kayako_files_bulk_delete** — Delete files. DELETE /api/v1/files
- **list_all_kayako_twitter_accounts** — List all Kayako Twitter accounts ordered by id descending. Returns: id, uuid, screen_name, profile_image_url, brand, route_mentions, route_messages, route_favorites, show_in_help_center, status, is_enabled, last_synced_at, created_at, updated_at, resource_type, resource_url, view, count, case_count_accuracy, latest_case_id, realtime_channel.
- **get_single_kayako_twitter_account_by_id** — Get a single Kayako Twitter account by id. Returns: id, uuid, screen_name, profile_image_url, brand, route_mentions, route_messages, route_favorites, show_in_help_center, status, is_enabled, last_synced_at, created_at, updated_at, resource_type, resource_url, view, count, case_count_accuracy, latest_case_id, realtime_channel. Required: id.
- **update_a_kayako_twitter_account_by_id** — Update an account. PUT /api/v1/twitter/accounts/{{id}}
- **kayako_twitter_accounts_bulk_update** — Update accounts. PUT /api/v1/twitter/accounts
- **delete_a_kayako_twitter_account_by_id** — Delete an account. DELETE /api/v1/twitter/accounts/{{id}}
- **kayako_twitter_accounts_bulk_delete** — Delete accounts. DELETE /api/v1/twitter/accounts
- **list_all_kayako_facebook_accounts** — List all Facebook accounts in Kayako. Returns: id, account_id, title, profile_image_url, status, created_at, updated_at, resource_type, resource_url. Ordered by id ascending.
- **get_single_kayako_facebook_account_by_id** — Get a single Facebook account in Kayako by id. Returns: id, account_id, title, profile_image_url, status, created_at, updated_at, resource_type, resource_url. Required: id.
- **kayako_facebook_accounts_callback** — Callback handler. GET /api/v1/facebook/account/callback
- **kayako_facebook_accounts_link** — Add an account RESOURCE FIELDS Name Type Read-only Description link string Retrieve link. GET /api/v1/facebook/account/link
- **list_all_kayako_case_views** — List all Kayako case views ordered by sort_order ascending. Returns: id, title, type, visibility_type, agent, visibility_to_teams, columns, predicate_collections, order_by_column, order_by, sort_order, is_default, is_system, is_enabled, realtime_channel, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_case_view_by_id** — Get a single Kayako case view by id. Returns the full view object including id, title, type, visibility_type, order_by_column, order_by, sort_order, is_enabled, created_at, and updated_at. Required: id.
- **create_a_kayako_case_view** — Create a new Kayako case view with title, visibility, columns, and filter predicates. Returns the created view object including id, title, type, visibility_type, is_enabled, created_at, and updated_at.
- **update_a_kayako_case_view_by_id** — Update an existing Kayako case view by id. All columns must be passed on update; omitted columns are removed from the view. Returns: id, title, type, visibility_type, agent, visibility_to_teams, columns, predicate_collections, order_by_column, order_by, sort_order, is_default, is_system, is_enabled, realtime_channel, created_at, updated_at, resource_type, resource_url. Required: id.
- **delete_a_kayako_case_view_by_id** — Delete a Kayako case view by id. Returns an empty 204 response on success. Required: id.
- **kayako_case_views_bulk_update** — Update views. PUT /api/v1/views Required body params: is_enabled.
- **kayako_case_views_reorder** — Reorder views. PUT /api/v1/views/reorder Required body params: view_ids.
- **kayako_case_views_bulk_delete** — Delete views. DELETE /api/v1/views
- **kayako_case_views_list_definitions** — Definitions RESOURCE FIELDS Name Type Read-only Description label string field string Field name on which the rules will be applied type string NUMERIC, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, DATE_RELATIVE, TIME sub_type string Depends on type: NUMERIC: FLOAT, INTEGER DATE_RELATIVE: PAST, PAST_OR_PRESENT, PRESENT, PAST_OR_FUTURE, FUTURE group string CASES, REQUESTER, ORGANIZATION, SLA, SATISFACTION rarity string COMMON, LESS_COMMON description string Field description input_type string INTEGER, FLOAT, STRING, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, OPTIONS, MULTIPLE, TAGS, DATE_ABSOLUTE, DATE_RELATIVE, AUTOCOMPLETE, TIME operators array Depends on input_type: INTEGER, FLOAT: comparison_equalto, comparison_not_equalto, comparison_greaterthan, comparison_greaterthan_or_equalto, comparison_lessthan, comparison_lessthan_or_equalto STRING: string_contains_insensitive, string_does_not_contain_insensitive BOOLEAN: comparison_equalto, comparison_not_equalto BOOLEAN_TRUE: comparison_equalto BOOLEAN_FALSE: comparison_equalto OPTIONS: comparison_equalto, comparison_not_equalto TAGS: collection_contains_insensitive, collection_contains_any_insensitive AUTOCOMPLETE: comparison_equalto, comparison_not_equalto TIME: time_greaterthan, time_greaterthan_or_equalto, time_lessthan, time_lessthan_or_equalto DATE_ABSOLUTE: date_is, date_is_not DATE_RELATIVE: date_after, date_after_or_on, date_before, date_before_or_on values mixed Input type: OPTIONS {"1":"New", "2":"Open", "3":"Pending", "4":"Completed"} Input type: INTEGER or FLOAT or BOOLEAN or BOOLEAN_TRUE or BOOLEAN_FALSE or TAGS or STRING or DATE_ABSOLUTE or TIME value n/a Input type: MULTIPLE {"1":"New", "2":"Open", "3":"Pending", "4":"Completed"} Input type: AUTOCOMPLETE {"(assignee)": "(Assignee)", "(requester)": "(Requester)"} other values needs to fetch from AUTOCOMPLETE Input type: RELATIVE {"today":"today", "currentweek":"currentweek", "currentmonth":"currentmonth"} Retrieve all definitions. GET /api/v1/views/definitions
- **kayako_case_views_list_columns** — Autocomplete Autocomplete Name Type Read-only Description users.organizationid Organization cases.requesterid User cases.assigneeagentid User Filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS cases.lastupdatedby User Filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS Columns RESOURCE FIELDS Name Type Read-only Description title string name string Retrieve all columns. GET /api/v1/views/columns
- **kayako_case_views_list_cases** — Retrieve conversations. GET /api/v1/views/{{id}}/cases
- **kayako_case_views_list_counts** — Counts RESOURCE FIELDS Name Type Read-only Description view View count integer Total number of conversations case_count_accuracy string ABSOLUTE, RELATIVE latest_case_id integer id of the most recently created Conversation in this view realtime_channel string Subscribe to this channel for realtime updates Retrieve counts. GET /api/v1/views/counts
- **kayako_case_views_get_count** — Retrieve a count. GET /api/v1/views/counts/{{id}}
- **list_all_kayako_case_forms** — List all Kayako case forms ordered by sort_order ascending. Returns: id, title, is_visible_to_customers, customer_title, customer_titles, description, descriptions, is_enabled, is_default, is_deleted, sort_order, fields, brand, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_case_form_by_id** — Get a single Kayako case form by id. Returns: id, title, is_visible_to_customers, customer_title, customer_titles, description, descriptions, is_enabled, is_default, is_deleted, sort_order, fields, brand, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_case_form** — Create a new Kayako case form. Returns the created form object including id, title, is_visible_to_customers, is_enabled, sort_order, created_at, and updated_at.
- **update_a_kayako_case_form_by_id** — Update an existing Kayako case form by id. Returns the updated form object including id, title, is_visible_to_customers, is_enabled, sort_order, fields, brand, created_at, and updated_at. Required: id. Warning: all case_field_ids must be passed on update; ids not passed will be removed.
- **delete_a_kayako_case_form_by_id** — Delete a Kayako case form by id. Returns an empty 204 response on success. Required: id.
- **kayako_case_forms_mark_default** — Mark as default. PUT /api/v1/cases/forms/default Required body params: form_id.
- **kayako_case_forms_bulk_update** — Update forms. PUT /api/v1/cases/forms Required body params: is_enabled.
- **kayako_case_forms_reorder** — Reorder forms. PUT /api/v1/cases/forms/reorder Required body params: form_ids.
- **kayako_case_forms_bulk_delete** — Delete forms. DELETE /api/v1/cases/forms
- **list_all_kayako_case_slas** — List all Kayako case service level agreements ordered by updated_at descending. Returns: id, title, description, execution_order, predicate_collections, targets, is_enabled, is_deleted, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_case_sla_by_id** — Get a single Kayako case service level agreement by id. Returns: id, title, description, execution_order, predicate_collections, targets, is_enabled, is_deleted, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_case_sla** — Create a new Kayako case service level agreement with predicate collections and targets. Returns: id, title, description, execution_order, predicate_collections, targets, is_enabled, is_deleted, created_at, updated_at, resource_type, resource_url.
- **update_a_kayako_case_sla_by_id** — Update an existing Kayako case service level agreement by id, replacing predicate collections and targets. Returns: id, title, description, execution_order, predicate_collections, targets, is_enabled, is_deleted, created_at, updated_at, resource_type, resource_url. Required: id.
- **delete_a_kayako_case_sla_by_id** — Delete a Kayako case service level agreement by id. Returns an empty 204 response on success. Required: id.
- **kayako_case_slas_bulk_update** — Update SLAs. PUT /api/v1/slas Required body params: is_enabled.
- **kayako_case_slas_reorder** — Reorder SLAs. PUT /api/v1/slas/reorder Required body params: sla_ids.
- **kayako_case_slas_bulk_delete** — Delete SLAs. DELETE /api/v1/slas
- **kayako_case_slas_list_definitions** — Definitions RESOURCE FIELDS Name Type Read-only Description label string field string Field name on which the rules will be applied type string NUMERIC, FLOAT, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, DATE_RELATIVE, TIME sub_type string Depends on type: NUMERIC: FLOAT, INTEGER DATE_RELATIVE: PAST, PAST_OR_PRESENT, PRESENT, PAST_OR_FUTURE, FUTURE group string CASES, REQUESTER, ORGANIZATION, SLA rarity string COMMON, LESS_COMMON description string Field description input_type string INTEGER, FLOAT, STRING, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, OPTIONS, MULTIPLE, TAGS, DATE_ABSOLUTE, DATE_RELATIVE, AUTOCOMPLETE, TIME operators array Depends on input_type: INTEGER, FLOAT: comparison_equalto, comparison_not_equalto, comparison_greaterthan, comparison_greaterthan_or_equalto, comparison_lessthan, comparison_lessthan_or_equalto STRING: string_contains_insensitive, string_does_not_contain_insensitive BOOLEAN: comparison_equalto, comparison_not_equalto BOOLEAN_TRUE: comparison_equalto BOOLEAN_FALSE: comparison_equalto OPTIONS: comparison_equalto, comparison_not_equalto TAGS: collection_contains_insensitive, collection_contains_any_insensitive AUTOCOMPLETE: comparison_equalto, comparison_not_equalto TIME: time_greaterthan, time_greaterthan_or_equalto, time_lessthan, time_lessthan_or_equalto DATE_ABSOLUTE: date_is, date_is_not DATE_RELATIVE: date_after, date_after_or_on, date_before, date_before_or_on values mixed Values for a definition with input_type as AUTOCOMPLETE will not be provided by the server Retrieve all definitions. GET /api/v1/slas/definitions
- **kayako_events_webhook_incoming** — Incoming webhook. POST /api/v1/webhook/{{query.token}}/incoming Required body params: event, user.
- **kayako_events_bulk_webhook_incoming** — Bulk Incoming webhook. POST /api/v1/bulk/webhook/{{query.token}}/incoming Required body params: events.
- **list_all_kayako_triggers** — Retrieve all triggers. GET /api/v1/triggers
- **get_single_kayako_trigger_by_id** — Retrieve a trigger. GET /api/v1/triggers/{{id}}
- **create_a_kayako_trigger** — Add a trigger. POST /api/v1/triggers Required body params: title, predicate_collections[], actions[].
- **update_a_kayako_trigger_by_id** — Update a trigger. PUT /api/v1/triggers/{{id}}
- **delete_a_kayako_trigger_by_id** — Delete a trigger. DELETE /api/v1/triggers/{{id}}
- **kayako_triggers_list_channels** — Channels RESOURCE FIELDS Name Type Read-only Description name string API, MAIL, TWITTER, FACEBOOK, MESSENGER, SYSTEM event string When there are no events, (Any) is implied Retrieve all trigger channels. GET /api/v1/triggers/channels
- **kayako_triggers_list_definitions** — Propositions RESOURCE FIELDS Name Type Read-only Description label string field string Field name on which the rules will be applied type string NUMERIC, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, DATE_RELATIVE, TIME sub_type string Depends on type: NUMERIC: FLOAT, INTEGER DATE_RELATIVE: PAST, PAST_OR_PRESENT, PRESENT, PAST_OR_FUTURE, FUTURE group string CASES, REQUESTER, ORGANIZATION, SLA, SATISFACTION rarity string COMMON, LESS_COMMON description string Field description input_type string INTEGER, FLOAT, STRING, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, OPTIONS, MULTIPLE, TAGS, DATE_ABSOLUTE, DATE_RELATIVE, AUTOCOMPLETE, TIME operators array Depends on input_type: INTEGER, FLOAT: comparison_equalto, comparison_not_equalto, comparison_greaterthan, comparison_greaterthan_or_equalto, comparison_lessthan, comparison_lessthan_or_equalto STRING: string_contains_insensitive, string_does_not_contain_insensitive BOOLEAN: comparison_equalto, comparison_not_equalto BOOLEAN_TRUE: comparison_equalto BOOLEAN_FALSE: comparison_equalto OPTIONS: comparison_equalto, comparison_not_equalto TAGS: collection_contains_insensitive, collection_contains_any_insensitive AUTOCOMPLETE: comparison_equalto, comparison_not_equalto TIME: time_greaterthan, time_greaterthan_businesshours, time_greaterthan_or_equalto, time_greaterthan_or_equalto_businesshours, time_lessthan, time_lessthan_businesshours, time_lessthan_or_equalto, time_lessthan_or_equalto_businesshours DATE_ABSOLUTE: date_is, date_is_not DATE_RELATIVE: date_after, date_after_or_on, date_before, date_before_or_on values mixed Input type: OPTIONS {"1":"New", "2":"Open", "3":"Pending", "4":"Completed"} Input type: INTEGER, FLOAT, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, TAGS, STRING, DATE_ABSOLUTE or TIME value n/a Input type: MULTIPLE {"1":"New", "2":"Open", "3":"Pending", "4":"Completed"} Input type: AUTOCOMPLETE {"(assignee)": "(Assignee)", "(requester)": "(Requester)"} other values needs to fetch from AUTOCOMPLETE Input type: RELATIVE {"today":"today", "currentweek":"currentweek", "currentmonth":"currentmonth"} Autocomplete Autocomplete Name Type Read-only Description users.organizationid Organization cases.requesterid User cases.assigneeagentid User Filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS cases.lastupdatedby User Filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS Retrieve all propositions. GET /api/v1/triggers/definitions
- **kayako_triggers_bulk_delete** — Delete triggers. DELETE /api/v1/triggers
- **kayako_triggers_list_action_definitions** — Actions RESOURCE FIELDS Name Type Read-only Description label string name string The name can be retrieved from Definition option string The option can be retrieved from Definition value mixed attributes Attributes Attributes RESOURCE FIELDS Name Type Read-only Description name string value mixed Definitions RESOURCE FIELDS Name Type Read-only Description label string name string Action name on which the trigger will run options string CHANGE, REVERT, INCREASE, DECREASE, ADD, REMOVE, REPLACE, SEND rarity string COMMON, LESS_COMMON description string Action description input_type string INTEGER, FLOAT, STRING, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, OPTIONS, MULTIPLE, TAGS, ENDPOINT_EMAIL, ENDPOINT_HTTP, ENDPOINT_HTTP_JSON, ENDPOINT_HTTP_XML, ENDPOINT_SLACK, DATE_ABSOLUTE, EMAIL, AUTOCOMPLETE, NOTIFICATION_USER, NOTIFICATION_TEAM, CASCADING_SELECT value_type string NUMERIC, FLOAT, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, TIME, ATTRIBUTES values mixed For label Email a user use its action values with the User autocomplete filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS attributes mixed group string CASE, CUSTOM_FIELD, NOTIFICATION, ENDPOINT, FLOW_CONTROL Retrieve all action definitions. GET /api/v1/triggers/actions/definitions
- **kayako_triggers_reorder** — Reorder triggers. PUT /api/v1/triggers/reorder Required body params: trigger_ids.
- **list_all_kayako_monitors** — Retrieve all monitors. GET /api/v1/monitors
- **get_single_kayako_monitor_by_id** — Retrieve a monitor. GET /api/v1/monitors/{{id}}
- **create_a_kayako_monitor** — Add a monitor. POST /api/v1/monitors Required body params: title, predicate_collections[], actions[].
- **update_a_kayako_monitor_by_id** — Update a monitor. PUT /api/v1/monitors/{{id}}
- **delete_a_kayako_monitor_by_id** — Delete a monitor. DELETE /api/v1/monitors/{{id}}
- **kayako_monitors_list_definitions** — Propositions RESOURCE FIELDS Name Type Read-only Description label string field string Field name on which the rules will be applied type string NUMERIC, FLOAT, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, DATE_RELATIVE, TIME sub_type string Depends on type: NUMERIC: FLOAT, INTEGER DATE_RELATIVE: PAST, PAST_OR_PRESENT, PRESENT, PAST_OR_FUTURE, FUTURE group string CASES, REQUESTER, ORGANIZATION, SLA, SATISFACTION rarity string COMMON, LESS_COMMON description string Field description input_type string INTEGER, FLOAT, STRING, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, OPTIONS, MULTIPLE, TAGS, DATE_ABSOLUTE, DATE_RELATIVE, AUTOCOMPLETE, TIME operators array Depends on input_type: INTEGER, FLOAT: comparison_equalto, comparison_not_equalto, comparison_greaterthan, comparison_greaterthan_or_equalto, comparison_lessthan, comparison_lessthan_or_equalto STRING: string_contains_insensitive, string_does_not_contain_insensitive BOOLEAN: comparison_equalto, comparison_not_equalto BOOLEAN_TRUE: comparison_equalto BOOLEAN_FALSE: comparison_equalto OPTIONS: comparison_equalto, comparison_not_equalto TAGS: collection_contains_insensitive, collection_contains_any_insensitive AUTOCOMPLETE: comparison_equalto, comparison_not_equalto TIME: time_greaterthan, time_greaterthan_businesshours, time_greaterthan_or_equalto, time_greaterthan_or_equalto_businesshours, time_lessthan, time_lessthan_businesshours, time_lessthan_or_equalto, time_lessthan_or_equalto_businesshours DATE_ABSOLUTE: date_is, date_is_not DATE_RELATIVE: date_after, date_after_or_on, date_before, date_before_or_on values mixed Input type: OPTIONS {"1":"New", "2":"Open", "3":"Pending", "4":"Completed"} Input type: INTEGER, FLOAT, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, TAGS, STRING, DATE_ABSOLUTE or TIME value n/a Input type: MULTIPLE {"1":"New", "2":"Open", "3":"Pending", "4":"Completed"} Input type: AUTOCOMPLETE {"(assignee)": "(Assignee)", "(requester)": "(Requester)"} other values needs to fetch from AUTOCOMPLETE Input type: RELATIVE {"today":"today", "currentweek":"currentweek", "currentmonth":"currentmonth"} Autocomplete Autocomplete Name Type Read-only Description users.organizationid Organization cases.requesterid User cases.assigneeagentid User Filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS Retrieve all definitions. GET /api/v1/monitors/definitions
- **kayako_monitors_list_action_definitions** — Actions RESOURCE FIELDS Name Type Read-only Description label string name string The name can be retrieved from Definition option string The option can be retrieved from Definition value mixed attributes Attributes Attributes RESOURCE FIELDS Name Type Read-only Description name string value mixed Definitions RESOURCE FIELDS Name Type Read-only Description label string name string Action name on which the trigger will run options string CHANGE, REVERT, INCREASE, DECREASE, ADD, REMOVE, REPLACE, SEND rarity string COMMON, LESS_COMMON description string Action description input_type string INTEGER, FLOAT, STRING, BOOLEAN, BOOLEAN_TRUE, BOOLEAN_FALSE, OPTIONS, MULTIPLE, TAGS, ENDPOINT_EMAIL, ENDPOINT_HTTP, ENDPOINT_HTTP_JSON, ENDPOINT_HTTP_XML, ENDPOINT_SLACK, DATE_ABSOLUTE, EMAIL, AUTOCOMPLETE, NOTIFICATION_USER, NOTIFICATION_TEAM, CASCADING_SELECT value_type string NUMERIC, FLOAT, STRING, BOOLEAN, COLLECTION, DATE_ABSOLUTE, TIME, ATTRIBUTES values mixed For label Email a user use its action values with the User autocomplete filter by multiple comma separated values OWNERS, ADMINS, AGENTS, COLLABORATORS attributes mixed group string CASE, CUSTOM_FIELD, NOTIFICATION, ENDPOINT, FLOW_CONTROL Retrieve all action definitions. GET /api/v1/monitors/actions/definitions
- **kayako_monitors_reorder** — Reorder monitors. PUT /api/v1/monitors/reorder Required body params: monitor_ids.
- **kayako_monitors_bulk_delete** — Delete monitors. DELETE /api/v1/monitors
- **kayako_insights_cases_list_csat** — CSAT RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format previous_start_at timestamp ISO-8601 Format previous_end_at timestamp ISO-8601 Format interval string DAY, WEEK, MONTH, QUARTER, YEAR interval_count integer series Series metric Value Series RESOURCE FIELDS Name Type Read-only Description name string data array previous array Value RESOURCE FIELDS Name Type Read-only Description name string value integer previous integer delta_percent float Retrieve CSAT. GET /api/v1/insights/cases/csat
- **kayako_insights_cases_list_channel** — Channel RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format interval string DAY, WEEK, MONTH, QUARTER, YEAR interval_count integer channel_series array Channel Statistics RESOURCE FIELDS Name Type Read-only Description channel string series Series Retrieve Channel Statistics. GET /api/v1/insights/cases/channel
- **kayako_insights_cases_list_resolution** — Average Resolution RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format previous_start_at timestamp ISO-8601 Format previous_end_at timestamp ISO-8601 Format interval string DAY, WEEK, MONTH, QUARTER, YEAR interval_count integer series Series metric Value Retrieve Average Resolution. GET /api/v1/insights/cases/resolution
- **kayako_insights_cases_list_response** — Average Response RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format previous_start_at timestamp ISO-8601 Format previous_end_at timestamp ISO-8601 Format interval string DAY, WEEK, MONTH, QUARTER, YEAR interval_count integer series Series metric Value Retrieve Average Response. GET /api/v1/insights/cases/response
- **kayako_insights_cases_list_completed** — Case Completion RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format previous_start_at timestamp ISO-8601 Format previous_end_at timestamp ISO-8601 Format interval string DAY, WEEK, MONTH, QUARTER, YEAR interval_count integer series Series metric Value Retrieve Case Completion. GET /api/v1/insights/cases/completed
- **kayako_insights_cases_list_metrics** — Metrics RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format previous_start_at timestamp ISO-8601 Format previous_end_at timestamp ISO-8601 Format metrics array Retrieve Metrics. GET /api/v1/insights/cases/metrics
- **kayako_insights_help_center_list_search** — Search RESOURCE FIELDS Name Type Read-only Description start_at timestamp ISO-8601 Format end_at timestamp ISO-8601 Format popular_searches array Top 10 popular searches failed_searches array Top 10 failed searches Retrieve Search Statistics. GET /api/v1/insights/helpcenter/search
- **kayako_insights_help_center_list_articles** — Retrieve Article Statistics. GET /api/v1/insights/helpcenter/articles
- **list_all_kayako_help_centers** — List all help centers in Kayako. Returns: id, title, brand, ga_account_id, display_messenger, primary_color, font, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_help_center_by_id** — Get a single Kayako help center by id. Returns: id, title, brand, ga_account_id, display_messenger, primary_color, font, created_at, updated_at, resource_type, resource_url. Required: id.
- **update_a_kayako_help_center_by_id** — Update a Kayako help center by id. Returns the updated help center object including id, title, brand, primary_color, font, and created_at/updated_at timestamps. Required: id.
- **update_a_kayako_help_center_logo_by_id** — Update the logo for a specific Kayako help center by uploading a new image; large images will be scaled down. Returns: type, url. Required: helpcenter_id.
- **delete_a_kayako_help_center_logo_by_id** — Delete the logo for a specific Kayako help center. Returns an empty 204 response on success. Required: helpcenter_id.
- **kayako_help_center_logo_render** — Render logo. GET /api/v1/logo/render
- **update_a_kayako_help_center_favicon_by_id** — Replace the favicon image for a Kayako help center. Returns the updated favicon object including name, size, width, height, type, url, and thumbnails. Required: helpcenter_id. Only PNG images are allowed; large images will be scaled down.
- **delete_a_kayako_help_center_favicon_by_id** — Delete the favicon for a Kayako help center. Returns an empty 204 response on success. Required: helpcenter_id.
- **kayako_help_center_favicon_render** — Render favicon. GET /api/v1/favicon/render
- **kayako_help_center_search_search** — Search the Kayako help center for articles and conversations. Returns: id, resource_type, uuid, title, contents, link, original, created_at, updated_at. Query string must be at least 3 characters; `in` defaults to ALL.
- **kayako_comments_publish_comment** — Mark comment as published. PUT /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/publish
- **kayako_comments_mark_comment_spam** — Mark comment as spam. PUT /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/spam
- **kayako_comments_list_comment_likes** — Likes RESOURCE FIELDS Name Type Read-only Description user User created_at timestamp ISO-8601 Format Retrieve all likes. GET /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/likes
- **kayako_comments_like_comment** — Like a comment. POST /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/likes
- **kayako_comments_unlike_comment** — Unlike a comment. DELETE /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/likes
- **list_all_kayako_comments** — List Kayako help center comments ordered by creation date (descending). Returns: id, contents, is_html, status, user, replies, is_liked, like_count, created_at, updated_at, resource_type, resource_url. Filter by status using PUBLISHED or SPAM.
- **get_single_kayako_comment_by_id** — Get a single Kayako help center comment by id. Returns: id, contents, is_html, status, user, replies, is_liked, like_count, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_comment** — Create a new comment on a Kayako help center article. Returns: id, contents, is_html, status, user, replies, is_liked, like_count, created_at, updated_at, resource_type, resource_url.
- **update_a_kayako_comment_by_id** — Update a Kayako help center comment by id. Returns: id, contents, is_html, status, user, replies, is_liked, like_count, created_at, updated_at, resource_type, resource_url. Required: id. Users may only update their own comments within 10 minutes of creation.
- **delete_a_kayako_comment_by_id** — Delete a Kayako help center comment by id. Returns an empty 204 response on success. Required: id. Users may only delete their own comments within 10 minutes of creation.
- **list_all_kayako_help_center_conversations** — List Kayako help center conversations ordered by created_at descending. Returns: id, uuid, legacy_id, subject, channel, requester, creator, last_replier, last_agent_replier, assigned_team, assigned_agent, status, is_closed, priority, type, read_marker, custom_fields, last_message_status, last_message_preview, realtime_channel, last_replied_at, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_help_center_conversation_by_id** — Get a single Kayako help center conversation by id. Returns: id, uuid, legacy_id, subject, channel, requester, creator, last_replier, last_agent_replier, assigned_team, assigned_agent, status, is_closed, priority, type, read_marker, custom_fields, last_message_status, last_message_preview, realtime_channel, last_replied_at, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_help_center_conversation** — Create a new Kayako help center conversation with an initial message. Returns: id, uuid, legacy_id, subject, channel, requester, creator, last_replier, last_agent_replier, assigned_team, assigned_agent, status, is_closed, priority, type, read_marker, custom_fields, last_message_status, last_message_preview, realtime_channel, last_replied_at, created_at, updated_at, resource_type, resource_url.
- **kayako_help_center_conversations_list_participants** — Retrieve participants. GET /api/v1/conversations/{{query.conversation_id}}/participants
- **update_a_kayako_help_center_conversation_by_id** — Update a conversation. PUT /api/v1/conversations/{{id}}
- **kayako_help_center_conversations_list_messages** — Messages RESOURCE FIELDS Name Type Read-only Description uuid string client_id string client_id is provided by the client when creating a message. Can be used to identify messages reflected from the server back to the originating entity. This value may be null if not supplied by the client. Since this is only useful for realtime communication, older values might be erased periodically. subject string channel string Channel represents the source from which message was originally created. MAIL, HELPCENTER, TWITTER, MESSENGER, FACEBOOK content_text string content_html string creator User The creator of the post, represented as a user resource attachments Attachments download_all string source string API, AGENT, MAIL, MESSENGER, MOBILE, HELPCENTER metadata array Metadata will be in key - value pair message_status string SENT, DELIVERED, REJECTED, SEEN Default: SENT message_status_reject_type string BOUNCE, BLOCKED, DROPPED, DEFERRED, EXPIRED, ERROR Note: This field applicable for REJECTED message_status message_status_reject_reason string Reject reason from MTA Note: This field applicable for REJECTED message_status message_status_updated_at timestamp ISO-8601 Format created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format resource_type string Categorized the posts (Facebook, Twitter, Email etc.) Attachments RESOURCE FIELDS Name Type Read-only Description name string size integer width integer Only if the attachment is image height integer Only if the attachment is image type string Mime-type of the file content_id string Content ID used for inline attachment alt string url string The URL to view the attachment url_download string The URL to download the attachment thumbnails Thumbnails created_at timestamp ISO-8601 Format Thumbnails RESOURCE FIELDS Name Type Read-only Description name string size integer width integer height integer type string Mime-type of the file url string The URL to view the thumbnail created_at timestamp ISO-8601 Format Retrieve all messages. GET /api/v1/conversations/{{query.conversation_id}}/messages
- **kayako_help_center_conversations_get_message** — Retrieve a message. GET /api/v1/conversations/{{query.conversation_id}}/messages/{{id}}
- **kayako_help_center_conversations_create_message** — Add a message. POST /api/v1/conversations/{{query.conversation_id}}/messages Required body params: contents.
- **kayako_help_center_conversations_update_message** — Update a Message. PUT /api/v1/conversations/{{query.conversation_id}}/messages/{{id}} Required body params: message_status.
- **kayako_help_center_conversations_list_forms** — Conversation forms RESOURCE FIELDS Name Type Read-only Description title string Deprecated: This field will be removed soon titles Field Locales description string Deprecated: This field will be removed soon descriptions Field Locales fields Fields brand Brand created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Retrieve all forms. GET /api/v1/conversations/forms
- **kayako_help_center_conversations_get_form** — Retrieve a from. GET /api/v1/conversations/forms/{{id}}
- **kayako_help_center_conversations_list_fields** — Custom fields RESOURCE FIELDS Name Type Read-only Description fielduuid string titles Field Locales type string Supported Types: TEXT, TEXTAREA, CHECKBOX, RADIO, SELECT, DATE, FILE, NUMERIC, DECIMAL, YESNO, REGEX, CASCADINGSELECT key string descriptions Field Locales is_required boolean is_editable boolean is_system boolean regular_expression string options Options Presented for a field of type CHECKBOX, RADIO, SELECT, CASCADINGSELECT created_at string ISO-8601 Format updated_at string ISO-8601 Format Retrieve fields. GET /api/v1/conversations/fields
- **kayako_help_center_conversations_get_field** — Retrieve a field. GET /api/v1/conversations/fields/{{id}}
- **kayako_help_center_conversations_list_ratings** — Satisfaction Ratings RESOURCE FIELDS Name Type Read-only Description score string GOOD, BAD comment string The comment provided when creating this rating. Can be empty if no comment was provided. conversation Conversation The Conversation that this rating belongs to creator User The User that created this rating created_at timestamp ISO-8601 Format updated_at timestamp ISO-8601 Format Retrieve all ratings. GET /api/v1/conversations/{{query.conversation_id}}/ratings
- **kayako_help_center_conversations_create_rating** — Add a rating. POST /api/v1/conversations/{{query.conversation_id}}/ratings Required body params: score.
- **kayako_help_center_conversations_update_rating** — Update a rating. PUT /api/v1/conversations/{{query.conversation_id}}/ratings/{{id}} Required body params: score.
- **kayako_sessions_ack** — Update session activity. PUT /api/v1/session/ack
- **delete_a_kayako_session_by_id** — Delete a Kayako session by id. Returns an empty 204 response on success. Required: id.
- **kayako_case_satisfaction_ratings_list_recent** — Retrieve recent ratings. GET /api/v1/cases/ratings/recent
- **get_single_kayako_case_satisfaction_rating_by_id** — Retrieve a rating. GET /api/v1/cases/{{id}}/ratings/{{id}}
- **create_a_kayako_case_satisfaction_rating** — Add a rating. POST /api/v1/cases/{{id}}/ratings Required body params: hash, score.
- **update_a_kayako_case_satisfaction_rating_by_id** — Update a rating. PUT /api/v1/cases/{{id}}/ratings/{{id}} Required body params: hash, score.
- **kayako_case_satisfaction_ratings_trigger** — Trigger rating. POST /api/v1/cases/{{id}}/ratings/trigger
- **list_all_kayako_case_satisfaction_ratings** — Retrieve all ratings. GET /api/v1/cases/{{id}}/ratings
- **list_all_kayako_user_fields** — List all Kayako user custom fields ordered by sort_order ascending. Returns: id, fielduuid, title, type, key, is_visible_to_customers, customer_titles, is_customer_editable, is_required_for_customers, descriptions, regular_expression, sort_order, is_enabled, options, created_at, updated_at, resource_type, resource_url.
- **get_single_kayako_user_field_by_id** — Get a single Kayako user custom field by id. Returns: id, fielduuid, title, type, key, is_visible_to_customers, customer_titles, is_customer_editable, is_required_for_customers, descriptions, regular_expression, sort_order, is_enabled, options, created_at, updated_at, resource_type, resource_url. Required: id.
- **create_a_kayako_user_field** — Create a new Kayako user custom field. Returns the created field object including id, fielduuid, title, type, key, is_visible_to_customers, is_enabled, sort_order, created_at, and updated_at.
- **update_a_kayako_user_field_by_id** — Update an existing Kayako user custom field by id. Returns the updated field object including id, fielduuid, title, type, key, is_visible_to_customers, is_enabled, sort_order, created_at, and updated_at. Required: id.
- **kayako_user_fields_reorder** — Reorder Kayako user custom fields by specifying the desired field ordering. Returns: total_count. Required: field_ids.
- **delete_a_kayako_user_field_by_id** — Delete a Kayako user field by id. Returns an empty 204 response on success. Required: id.
- **kayako_user_fields_reorder_options** — Reorder options for a specific Kayako user field by passing option_ids in the desired order. Returns: status, total_count. Required: field_id.
- **kayako_user_fields_delete_option** — Delete a single option from a Kayako user field. Returns an empty 204 response on success. Required: field_id, option_id.
- **kayako_user_fields_delete_options_bulk** — Delete multiple options from a Kayako user field by passing comma-separated ids. Returns: status, total_count. Required: field_id.
- **kayako_user_fields_list_values** — List custom field values for a specific Kayako user. Returns: field, value, resource_type. Required: user_id.
- **kayako_user_fields_bulk_delete** — Delete multiple Kayako user fields by their ids. Returns: total_count. Required: ids.

## How it works

1. **Link your customer's Kayako account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Kayako.** The Proxy API is a 1-to-1 mapping of the Kayako API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Embed helpdesk context inside your CRM or CS platform** — Give your users a live view of their customers' Kayako cases, CSAT ratings, and organization history inside your product. Useful for CS platforms, CRMs, or account management tools that need support signals to drive health scores and playbooks.
- **Power AI deflection and agent assist on top of Kayako** — Ingest Help Center articles and historical case posts to train RAG-based support agents, then hand off unresolved conversations back into Kayako as new cases with the full transcript attached as an internal note.
- **Sync engineering issues bi-directionally with support cases** — Let your dev tool (issue tracker, incident manager, or DevEx platform) create linked GitHub/Jira/Linear issues from Kayako cases, then push status updates back as replies or status changes when the bug ships.
- **Automate ticket creation from your product's events** — Monitoring tools, e-commerce apps, and workflow platforms can programmatically open Kayako cases when something breaks — server outages, failed returns, billing errors — and route them to the right team with the right priority.
- **Feed QA and analytics warehouses with support data** — Pull closed cases, posts, notes, and satisfaction ratings into QA coaching tools, BI dashboards, or data warehouses so support leaders can measure agent quality and conversation trends outside of Kayako.

## What you can build

- **Two-way case sync** — Mirror Kayako cases in your product with real-time updates on status, priority, assignee, and replies using the cases and posts endpoints.
- **In-app reply composer** — Let users read case threads and post public replies or internal notes to Kayako from your UI via the case reply and notes endpoints.
- **Customer 360 context panel** — Resolve Kayako users by email or phone identity, pull their organization, cases, notes, and activity timeline, and render it inline wherever your users work.
- **Knowledge base ingestion for AI** — Sync articles, categories, and sections from Kayako Help Centers to power RAG pipelines, search, or chatbot answers.
- **Automated case creation from external events** — Create cases with custom fields, priority, brand, and assignee whenever your product detects an event that warrants human support.
- **CSAT and SLA reporting export** — Stream satisfaction ratings, SLA definitions, and case insights into analytics or coaching tools to benchmark team performance.

## FAQs

### How does authentication work for Kayako?

Kayako's API uses per-instance credentials tied to a customer's Kayako subdomain. Truto handles credential capture, storage, and injection so your end users connect their own Kayako account without you managing secrets or token refresh.

### Can I read and write custom fields on cases, users, and organizations?

Yes. Truto exposes case fields via the case objects, and dedicated endpoints exist for user fields and organization fields — including listing definitions, reading values, and updating them programmatically.

### How do I match a Kayako user to a contact in another system?

Kayako separates users from their identities. Use the identity email, phone, Twitter, and Facebook endpoints to resolve a user across channels, then join on the user object for their full profile and organization membership.

### Can I post replies and internal notes to an existing case?

Yes. Use the case reply endpoint to send customer-facing responses and the case notes endpoints to add internal-only notes visible to agents. Posts on a case can also be listed and updated individually.

### Does Truto support bulk operations to avoid rate limit issues?

Kayako exposes bulk endpoints for cases, users, organizations, tags, articles, categories, sections, and more. Truto passes these through so you can create, update, or delete in batches instead of firing one request per record.

### How do I stay in sync with changes happening in Kayako?

You can poll list endpoints for cases, posts, notes, users, and activities on your preferred cadence. Kayako also supports incoming webhooks, which Truto can normalize into events your backend consumes.

## Related reading

- [Connect Kayako to ChatGPT: Manage Cases, Users, and Help Center](https://truto.one/blog/connect-kayako-to-chatgpt-manage-cases-users-and-help-center/) — A definitive engineering guide to connecting Kayako to ChatGPT using a managed MCP server. Automate ticket triage, user identities, and help center operations.
- [Connect Kayako to Claude: Automate Support and Knowledge Base Tasks](https://truto.one/blog/connect-kayako-to-claude-automate-support-and-knowledge-base-tasks/) — Learn how to connect Kayako to Claude using a managed MCP server. Automate support tickets, draft knowledge base articles, and manage user workflows natively.
- [Connect Kayako to AI Agents: Sync Customer Profiles and Service Logs](https://truto.one/blog/connect-kayako-to-ai-agents-sync-customer-profiles-and-service-logs/) — Learn how to connect Kayako to AI Agents using Truto's /tools endpoint. Build autonomous support workflows, sync customer profiles, and handle cases safely.