Kayako MCP connector

• List 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 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 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 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.
• List 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,…
• List 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.
• List 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.
• List Kayako cases list used channels List channels used in a Kayako case conversation. Returns: uuid, type, character_limit, account, resource_type. Required: case_id.
• Create 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.
• Create Kayako cases bulk create Bulk add cases. POST /api/v1/bulk/cases Required body params: cases.
• Update Kayako cases bulk update Bulk update conversation. PUT /api/v1/cases
• Action Kayako cases trash Mark conversation as trash. PUT /api/v1/cases/{{id}}/trash
• Action Kayako cases bulk trash Bulk trash conversations. PUT /api/v1/cases/trash
• Action Kayako cases empty trash Empty trash. DELETE /api/v1/cases/trash
• Restore Kayako cases restore Restore a conversations. PUT /api/v1/cases/{{id}}/restore
• List 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
• Get Kayako cases get email original Retrieve a original email. GET /api/v1/cases/posts/{{id}}/email_original
• Get 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 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 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 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 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 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.
• Add 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.
• Action 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.
• Delete 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 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 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 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 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.
• Action 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 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.
• Delete 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 List all Kayako case priorities List all case priorities in Kayako. Returns: id, label, level, created_at, updated_at, resource_type, resource_url.
• Get 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 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 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.
• Action 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 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.
• Delete Kayako case priorities bulk delete Bulk delete multiple Kayako case priorities by comma-separated ids. Returns an empty response on success. Required: ids.
• List List all Kayako case types List all case types in Kayako. Returns: id, label, type, created_at, updated_at, resource_type, resource_url.
• Get 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 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 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 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.
• Delete 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 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 List all Kayako users Retrieve all users. GET /api/v1/users
• Get Get single Kayako user by ID Retrieve a user. GET /api/v1/users/{{id}}
• Create Create a Kayako user Add a user. POST /api/v1/users Required body params: role_id, full_name.
• Update Update a Kayako user by ID Update a user. PUT /api/v1/users/{{id}}
• Delete Delete a Kayako user by ID Delete a user. DELETE /api/v1/users/{{id}}
• Create Kayako users bulk create Bulk add users. POST /api/v1/bulk/users Required body params: users.
• Action 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.
• List 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
• List Kayako users list cases Retrieve user conversations. GET /api/v1/users/{{query.user_id}}/cases
• Delete Kayako users bulk delete Delete users. DELETE /api/v1/users
• Invite Kayako users invite Send invitation with details. POST /api/v1/users/invite Required body params: users.
• Update Kayako users bulk update Update users. PUT /api/v1/users
• Update Kayako users update password Update a password. PUT /api/v1/users/{{id}}/password Required body params: new_password.
• Action Kayako users reset password Reset password. POST /api/v1/password/reset Required body params: email.
• List 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
• Get Kayako users get post Retrieve a post. GET /api/v1/users/posts/{{id}}
• List 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 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 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 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.
• Send 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 Delete a Kayako identity email by ID Delete a Kayako email identity by id. Returns an empty 204 response on success. Required: id.
• Delete 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 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 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 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 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 Delete a Kayako identity phone by ID Delete a phone identity by id in Kayako. Returns an empty 204 response on success. Required: id.
• Delete 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 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 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 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 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 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.
• Delete 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 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 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 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 Delete a Kayako identity facebook by ID Delete a Facebook identity account by id. Returns an empty 204 response on success.
• Delete 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 List all Kayako organizations Retrieve all organizations. GET /api/v1/organizations
• Get Get single Kayako organization by ID Retrieve an organization. GET /api/v1/organizations/{{id}}
• Create Create a Kayako organization Add an organization. POST /api/v1/organizations
• Create Kayako organizations bulk create Bulk add organizations. POST /api/v1/bulk/organizations Required body params: organizations.
• Update Update a Kayako organization by ID Update an organization. PUT /api/v1/organizations/{{id}}
• Delete Delete a Kayako organization by ID Delete an organization. DELETE /api/v1/organizations/{{id}}
• Action Kayako organizations filter Retrieve smart lists of organizations. POST /api/v1/organizations/filter Required body params: predicates.
• List 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
• List Kayako organizations list members Retrieve members. GET /api/v1/organizations/{{query.organization_id}}/members
• List 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
• Get Kayako organizations get post Retrieve a post. GET /api/v1/organizations/posts/{{query.post_id}}
• List 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
• Add Kayako organizations add tags Add tags. POST /api/v1/organizations/{{query.organization_id}}/tags Required body params: tags.
• Delete Kayako organizations remove tags Remove tags. DELETE /api/v1/organizations/{{query.organization_id}}/tags
• Delete Kayako organizations bulk delete Delete organizations. DELETE /api/v1/organizations
• Update Kayako organizations bulk update Update organizations. PUT /api/v1/organizations Required body params: is_shared.
• List 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
• Get Kayako organizations get field Retrieve a field. GET /api/v1/organizations/fields/{{id}}
• Create Kayako organizations create field Add a field. POST /api/v1/organizations/fields Required body params: type, title.
• Update Kayako organizations update field Update a field. PUT /api/v1/organizations/fields/{{id}}
• Delete Kayako organizations delete field Delete a field. DELETE /api/v1/organizations/fields/{{id}}
• Delete Kayako organizations bulk delete fields Delete fields. DELETE /api/v1/organization/fields
• Delete Kayako organizations delete field option Delete a field option. DELETE /api/v1/organizations/fields/{{query.field_id}}/options/{{id}}
• Delete Kayako organizations bulk delete field options Delete field options. DELETE /api/v1/organizations/fields/{{query.field_id}}/options
• List 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
• Update Kayako organizations update field values Update field values. PUT /api/v1/organizations/{{query.organization_id}}/field/values Required body params: field_values.
• List 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
• List 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
• Get Kayako organizations get domain Retrieve a domain. GET /api/v1/identities/domains/{{id}}
• Create Kayako organizations create domain Add a domain. POST /api/v1/identities/domains Required body params: organization_id, domain.
• Update Kayako organizations update domain Update a domain. PUT /api/v1/identities/domains/{{id}}
• Delete Kayako organizations delete domain Delete domain. DELETE /api/v1/identities/domains/{{id}}
• Delete Kayako organizations bulk delete domains Delete domains. DELETE /api/v1/identities/domains
• List 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
• Get Kayako organizations get note Retrieve a note. GET /api/v1/organizations/{{query.organization_id}}/notes/{{id}}
• Create Kayako organizations create note Add a note. POST /api/v1/organizations/{{query.organization_id}}/notes Required body params: contents.
• Update Kayako organizations update note Update a note. PUT /api/v1/organizations/{{query.organization_id}}/notes/{{id}} Required body params: is_pinned.
• Action Kayako organizations replace tags Replace tags. PUT /api/v1/organizations/{{query.organization_id}}/tags Required body params: tags.
• Action Kayako organizations reorder fields Reorder fields. PUT /api/v1/organizations/fields/reorder Required body params: field_ids.
• Action 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 List all Kayako roles Retrieve all roles. GET /api/v1/roles
• Get Get single Kayako role by ID Retrieve a role. GET /api/v1/roles/{{id}}
• Create Create a Kayako role Add a role. POST /api/v1/roles Required body params: title.
• Update Update a Kayako role by ID Update a role. PUT /api/v1/roles/{{id}}
• Delete Delete a Kayako role by ID Delete a role. DELETE /api/v1/roles/{{id}}
• Delete Kayako roles bulk delete Delete roles. DELETE /api/v1/roles Required body params: ids.
• List 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
• Update Kayako roles update permissions Update permissions. PUT /api/v1/roles/{{id}}/permissions Required body params: permission.
• List 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 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 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 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 Delete a Kayako team by ID Delete a Kayako team by id. Returns an empty 204 response on success. Required: id.
• List Kayako teams list availability Retrieve available teams. GET /api/v1/teams/availability
• Create Kayako teams bulk create Bulk add teams. POST /api/v1/bulk/teams Required body params: teams.
• Delete Kayako teams bulk delete Delete teams. DELETE /api/v1/teams
• List Kayako teams list members Retrieve all members. GET /api/v1/teams/{{id}}/members
• Add Kayako teams add members Add a member. POST /api/v1/teams/{{id}}/members Required body params: agent_ids.
• Delete Kayako teams remove members Delete a member. DELETE /api/v1/teams/{{id}}/members
• List 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 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.
• Get Kayako user notes get note Retreive a note. GET /api/v1/users/{{query.user_id}}/notes/{{id}}
• Create Kayako user notes create note Add a note. POST /api/v1/users/{{query.user_id}}/notes Required body params: contents.
• Update Kayako user notes update note Update a note. PUT /api/v1/users/{{query.user_id}}/notes/{{id}} Required body params: is_pinned.
• List 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 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.
• List 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,…
• List 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 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.
• Create 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 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.
• Action 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 Delete a Kayako article by ID Delete a Kayako help center article by id. Returns an empty 200 response on success. Required: id.
• Search 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.
• Delete 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.
• Update 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 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 Get single Kayako article vote by ID Retrieve a vote. GET /api/v1/articles/{{query.article_id}}/votes/{{id}}
• Action Kayako article votes check voted Retrieve vote status. GET /api/v1/articles/{{query.article_id}}/hasvoted
• Action Kayako article votes vote helpful Vote as helpful. POST /api/v1/articles/{{query.article_id}}/votes/helpful
• Action Kayako article votes vote not helpful Vote as not helpful. POST /api/v1/articles/{{query.article_id}}/votes/nothelpful
• Delete Delete a Kayako article vote by ID Delete a vote. DELETE /api/v1/articles/{{query.article_id}}/votes/{{id}}
• Delete Kayako article votes bulk delete Delete votes. DELETE /api/v1/articles/{{query.article_id}}/votes
• List 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 Delete a Kayako article attachment by ID Delete an attachment. DELETE /api/v1/articles/{{query.article_id}}/attachments/{{id}}
• List List all Kayako categories Retrieve all categories. GET /api/v1/categories
• Get Get single Kayako category by ID Retrieve a category. GET /api/v1/categories/{{id}}
• Create Create a Kayako category Add a category. POST /api/v1/categories Required body params: titles.
• Update Update a Kayako category by ID Update a category. PUT /api/v1/categories/{{id}}
• Delete Delete a Kayako category by ID Delete a category. DELETE /api/v1/categories/{{id}}
• Create Kayako categories bulk create Bulk add categories. POST /api/v1/bulk/categories Required body params: categories.
• Update Kayako categories bulk update Update categories. PUT /api/v1/categories
• Action Kayako categories reorder Reorder categories. PUT /api/v1/categories/reorder Required body params: category_ids.
• Delete Kayako categories bulk delete Delete categories. DELETE /api/v1/categories
• List List all Kayako sections Retrieve all sections. GET /api/v1/sections
• Get Get single Kayako section by ID Retrieve a section. GET /api/v1/sections/{{id}}
• Create Create a Kayako section Add a section. POST /api/v1/sections Required body params: titles, category_id.
• Update Update a Kayako section by ID Update a section. PUT /api/v1/sections/{{id}}
• Delete Delete a Kayako section by ID Delete a section. DELETE /api/v1/sections/{{id}}
• Create Kayako sections bulk create Bulk add sections. POST /api/v1/bulk/sections Required body params: sections.
• Update Kayako sections bulk update Update sections. PUT /api/v1/sections
• Delete Kayako sections bulk delete Delete sections. DELETE /api/v1/sections
• Action Kayako sections reorder Reorder Sections. PUT /api/v1/sections/reorder Required body params: section_ids.
• List List all Kayako mailboxes Retrieve all mailboxes. GET /api/v1/mailboxes
• Get Get single Kayako mailbox by ID Retrieve a mailbox. GET /api/v1/mailboxes/{{id}}
• Get Kayako mailboxes get configuration Retrieve mailbox configuration. GET /api/v1/mailboxes/{{query.mailbox_id}}/configuration
• Create Create a Kayako mailbox Add a mailbox. POST /api/v1/mailboxes Required body params: address.
• Update Update a Kayako mailbox by ID Update a mailbox. PUT /api/v1/mailboxes/{{id}}
• Action Kayako mailboxes mark default Mark as default. PUT /api/v1/mailboxes/default Required body params: mailbox_id.
• Delete Delete a Kayako mailbox by ID Delete a mailbox. DELETE /api/v1/mailboxes/{{id}}
• Delete Kayako mailboxes bulk delete Delete mailboxes. DELETE /api/v1/mailboxes
• Update Kayako mailboxes bulk update Update mailboxes. PUT /api/v1/mailboxes Required body params: is_enabled.
• Search Kayako search search Unified search. GET /api/v1/search
• List List all Kayako brands Retrieve all brands. GET /api/v1/brands
• Get Get single Kayako brand by ID Retrieve a brand. GET /api/v1/brands/{{id}}
• Create Create a Kayako brand Add a brand. POST /api/v1/brands Required body params: sub_domain, locale_id.
• Update Update a Kayako brand by ID Update a brand. PUT /api/v1/brands/{{id}}
• Delete Delete a Kayako brand by ID Delete a brand. DELETE /api/v1/brands/{{id}}
• Action Kayako brands check available Check domain availability. POST /api/v1/brands/available Required body params: sub_domain.
• Validate Kayako brands validate Validate alias. POST /api/v1/brands/validate Required body params: sub_domain, alias.
• Get Kayako brands get certificate Get SSL Certificate. GET /api/v1/brands/{{query.brand_id}}/certificate
• Update Kayako brands bulk update Mass action on brands. PUT /api/v1/brands Required body params: is_enabled.
• Delete Kayako brands bulk delete Delete brands. DELETE /api/v1/brands
• List Kayako autocomplete list emails Emails RESOURCE FIELDS Name Type Read-only Description identity Email parent Resource Lookup emails. GET /api/v1/autocomplete/emails
• List Kayako autocomplete list tags Tags RESOURCE FIELDS Name Type Read-only Description tags string Lookup tags. GET /api/v1/autocomplete/tags
• List Kayako autocomplete list organizations Organizations RESOURCE FIELDS Name Type Read-only Description organization Organization Lookup organizations. GET /api/v1/autocomplete/organizations
• List Kayako autocomplete list users Users RESOURCE FIELDS Name Type Read-only Description user User Lookup users. GET /api/v1/autocomplete/users
• List List all Kayako files Retrieve all files. GET /api/v1/files
• Get Get single Kayako file by ID Retrieve a file. GET /api/v1/files/{{id}}
• Create Create a Kayako file Add a file. POST /api/v1/files Required body params: content.
• Delete Delete a Kayako file by ID Delete a file. DELETE /api/v1/files/{{id}}
• Get Kayako files get content Download a file. GET /api/v1/files/{{query.file_id}}/content
• Delete Kayako files bulk delete Delete files. DELETE /api/v1/files
• List 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 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 Update a Kayako twitter account by ID Update an account. PUT /api/v1/twitter/accounts/{{id}}
• Update Kayako twitter accounts bulk update Update accounts. PUT /api/v1/twitter/accounts
• Delete Delete a Kayako twitter account by ID Delete an account. DELETE /api/v1/twitter/accounts/{{id}}
• Delete Kayako twitter accounts bulk delete Delete accounts. DELETE /api/v1/twitter/accounts
• List 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 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.
• Action Kayako facebook accounts callback Callback handler. GET /api/v1/facebook/account/callback
• Action 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 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 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 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 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 Delete a Kayako case view by ID Delete a Kayako case view by id. Returns an empty 204 response on success. Required: id.
• Update Kayako case views bulk update Update views. PUT /api/v1/views Required body params: is_enabled.
• Action Kayako case views reorder Reorder views. PUT /api/v1/views/reorder Required body params: view_ids.
• Delete Kayako case views bulk delete Delete views. DELETE /api/v1/views
• List 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
• List 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
• List Kayako case views list cases Retrieve conversations. GET /api/v1/views/{{id}}/cases
• List 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
• Get Kayako case views get count Retrieve a count. GET /api/v1/views/counts/{{id}}
• List 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 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 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 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 Delete a Kayako case form by ID Delete a Kayako case form by id. Returns an empty 204 response on success. Required: id.
• Action Kayako case forms mark default Mark as default. PUT /api/v1/cases/forms/default Required body params: form_id.
• Update Kayako case forms bulk update Update forms. PUT /api/v1/cases/forms Required body params: is_enabled.
• Action Kayako case forms reorder Reorder forms. PUT /api/v1/cases/forms/reorder Required body params: form_ids.
• Delete Kayako case forms bulk delete Delete forms. DELETE /api/v1/cases/forms
• List 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 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 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 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 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.
• Update Kayako case slas bulk update Update SLAs. PUT /api/v1/slas Required body params: is_enabled.
• Action Kayako case slas reorder Reorder SLAs. PUT /api/v1/slas/reorder Required body params: sla_ids.
• Delete Kayako case slas bulk delete Delete SLAs. DELETE /api/v1/slas
• List 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
• Action Kayako events webhook incoming Incoming webhook. POST /api/v1/webhook/{{query.token}}/incoming Required body params: event, user.
• Action Kayako events bulk webhook incoming Bulk Incoming webhook. POST /api/v1/bulk/webhook/{{query.token}}/incoming Required body params: events.
• List List all Kayako triggers Retrieve all triggers. GET /api/v1/triggers
• Get Get single Kayako trigger by ID Retrieve a trigger. GET /api/v1/triggers/{{id}}
• Create Create a Kayako trigger Add a trigger. POST /api/v1/triggers Required body params: title, predicate_collections[], actions[].
• Update Update a Kayako trigger by ID Update a trigger. PUT /api/v1/triggers/{{id}}
• Delete Delete a Kayako trigger by ID Delete a trigger. DELETE /api/v1/triggers/{{id}}
• List 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
• List 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
• Delete Kayako triggers bulk delete Delete triggers. DELETE /api/v1/triggers
• List 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
• Action Kayako triggers reorder Reorder triggers. PUT /api/v1/triggers/reorder Required body params: trigger_ids.
• List List all Kayako monitors Retrieve all monitors. GET /api/v1/monitors
• Get Get single Kayako monitor by ID Retrieve a monitor. GET /api/v1/monitors/{{id}}
• Create Create a Kayako monitor Add a monitor. POST /api/v1/monitors Required body params: title, predicate_collections[], actions[].
• Update Update a Kayako monitor by ID Update a monitor. PUT /api/v1/monitors/{{id}}
• Delete Delete a Kayako monitor by ID Delete a monitor. DELETE /api/v1/monitors/{{id}}
• List 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
• List 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
• Action Kayako monitors reorder Reorder monitors. PUT /api/v1/monitors/reorder Required body params: monitor_ids.
• Delete Kayako monitors bulk delete Delete monitors. DELETE /api/v1/monitors
• List 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
• List 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
• List 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
• List 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
• List 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
• List 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
• Search 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
• List Kayako insights help center list articles Retrieve Article Statistics. GET /api/v1/insights/helpcenter/articles
• List 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 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 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 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 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.
• Action Kayako help center logo render Render logo. GET /api/v1/logo/render
• Update 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 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.
• Action Kayako help center favicon render Render favicon. GET /api/v1/favicon/render
• Search 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.
• Publish Kayako comments publish comment Mark comment as published. PUT /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/publish
• Action Kayako comments mark comment spam Mark comment as spam. PUT /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/spam
• List 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
• Action Kayako comments like comment Like a comment. POST /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/likes
• Action Kayako comments unlike comment Unlike a comment. DELETE /api/v1/articles/{{query.article_id}}/comments/{{query.comment_id}}/likes
• List 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 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 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 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 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 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 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 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.
• List Kayako help center conversations list participants Retrieve participants. GET /api/v1/conversations/{{query.conversation_id}}/participants
• Update Update a Kayako help center conversation by ID Update a conversation. PUT /api/v1/conversations/{{id}}
• List 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
• Get Kayako help center conversations get message Retrieve a message. GET /api/v1/conversations/{{query.conversation_id}}/messages/{{id}}
• Create Kayako help center conversations create message Add a message. POST /api/v1/conversations/{{query.conversation_id}}/messages Required body params: contents.
• Update Kayako help center conversations update message Update a Message. PUT /api/v1/conversations/{{query.conversation_id}}/messages/{{id}} Required body params: message_status.
• List 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
• Get Kayako help center conversations get form Retrieve a from. GET /api/v1/conversations/forms/{{id}}
• List 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
• Get Kayako help center conversations get field Retrieve a field. GET /api/v1/conversations/fields/{{id}}
• List 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
• Create Kayako help center conversations create rating Add a rating. POST /api/v1/conversations/{{query.conversation_id}}/ratings Required body params: score.
• Update Kayako help center conversations update rating Update a rating. PUT /api/v1/conversations/{{query.conversation_id}}/ratings/{{id}} Required body params: score.
• Action Kayako sessions ack Update session activity. PUT /api/v1/session/ack
• Delete Delete a Kayako session by ID Delete a Kayako session by id. Returns an empty 204 response on success. Required: id.
• List Kayako case satisfaction ratings list recent Retrieve recent ratings. GET /api/v1/cases/ratings/recent
• Get Get single Kayako case satisfaction rating by ID Retrieve a rating. GET /api/v1/cases/{{id}}/ratings/{{id}}
• Create Create a Kayako case satisfaction rating Add a rating. POST /api/v1/cases/{{id}}/ratings Required body params: hash, score.
• Update Update a Kayako case satisfaction rating by ID Update a rating. PUT /api/v1/cases/{{id}}/ratings/{{id}} Required body params: hash, score.
• Action Kayako case satisfaction ratings trigger Trigger rating. POST /api/v1/cases/{{id}}/ratings/trigger
• List List all Kayako case satisfaction ratings Retrieve all ratings. GET /api/v1/cases/{{id}}/ratings
• List 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 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 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 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.
• Action Kayako user fields reorder Reorder Kayako user custom fields by specifying the desired field ordering. Returns: total_count. Required: field_ids.
• Delete Delete a Kayako user field by ID Delete a Kayako user field by id. Returns an empty 204 response on success. Required: id.
• Action 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.
• Delete 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.
• Delete 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.
• List Kayako user fields list values List custom field values for a specific Kayako user. Returns: field, value, resource_type. Required: user_id.
• Delete Kayako user fields bulk delete Delete multiple Kayako user fields by their ids. Returns: total_count. Required: ids.

No tools match your search.