Zendesk - Help Center
API integration

list_all_zendesk_help_center_articles

List articles in Zendesk Help Center. Returns: author_id, body, comments_disabled, content_tag_ids, created_at, draft, edited_at, html_url, id, label_names, locale, outdated, outdated_locales, permission_group_id, position, promoted, section_id, source_locale, title, updated_at, url, user_segment_id, user_segment_ids, vote_count, vote_sum.

get_single_zendesk_help_center_article_by_id

Get a single Zendesk Help Center article by id. Returns the full article object including id, title, body, html_url, locale, and created_at. Required: id.

delete_a_zendesk_help_center_article_by_id

Archive a Help Center article by id, hiding it from the help center; the article can be restored in the Help Center user interface. Returns an empty 204 response on success. Required: id.

update_a_zendesk_help_center_article_by_id

Update a Help Center article by id. Returns the updated article object including its id. Required: id, article.

list_all_zendesk_help_center_article_comments

List all comments on a Zendesk Help Center article. Returns: id, body, author_id, locale, created_at, updated_at, and vote_count. Required: article_id.

get_single_zendesk_help_center_article_comment_by_id

Get a single comment on a Zendesk Help Center article by id. Returns: id, body, author_id, locale, created_at, updated_at, and vote_count. Required: article_id and id.

delete_a_zendesk_help_center_article_comment_by_id

Delete an article comment in Zendesk Help Center by id. Returns an empty 204 response on success. Required: id, article_id.

zendesk_help_center_article_comments_list_votes

List all votes cast by all users for a specific article comment in Zendesk Help Center. Returns: id, value, user_id, item_id, item_type, created_at, updated_at, url. Required: article_id, comment_id.

update_a_zendesk_help_center_article_comment_by_id

Update an article comment in Zendesk Help Center by id. Returns the updated comment including id, created_at, and updated_at. Required: id, article_id, comment.

list_all_zendesk_help_center_categories

List Zendesk Help Center categories. Returns: created_at, description, html_url, id, locale, name, outdated, position, source_locale, updated_at, url. Max 100 per page.

get_single_zendesk_help_center_category_by_id

Get a single Zendesk Help Center category by id. Returns: created_at, description, html_url, id, locale, name, outdated, position, source_locale, updated_at, url. Required: id.

create_a_zendesk_help_center_category

Create a category in Zendesk Help Center. Returns the created category including its id, name, locale, source_locale, and position. Requires name and locale; optionally accepts translations for additional locales, which must be enabled for the current Help Center. Required: name, locale.

delete_a_zendesk_help_center_category_by_id

Delete a category in Zendesk Help Center by id. Every section and all articles in the category will also be deleted. Returns an empty 204 response on success. Required: id.

update_a_zendesk_help_center_category_by_id

Update category-level metadata of a Zendesk Help Center category by id, such as its sorting position; category translations are not updated. Returns the updated category including its id, name, locale, and position. Required: id.

list_all_zendesk_help_center_sections

List sections in Zendesk Help Center. Returns: category_id, created_at, description, html_url, id, locale, name, outdated, parent_section_id, position, source_locale, theme_template, updated_at, url.

get_single_zendesk_help_center_section_by_id

Get a section in Zendesk Help Center by id. Returns: category_id, created_at, description, html_url, id, locale, name, outdated, parent_section_id, position, source_locale, theme_template, updated_at, url. Required: id.

delete_a_zendesk_help_center_section_by_id

Delete a section in Zendesk Help Center by id. WARNING: all articles in the section are also deleted. Returns an empty 204 response on success. Required: id.

update_a_zendesk_help_center_section_by_id

Update a section in Zendesk Help Center by id. Returns the updated section including id, name, locale, position, category_id, created_at, and updated_at. Required: id, section.

list_all_zendesk_help_center_labels

List all article labels in Zendesk Help Center. Returns: created_at, id, name, updated_at, url.

get_single_zendesk_help_center_label_by_id

Get a single article label in Zendesk Help Center by id. Returns: created_at, id, name, updated_at, url. Required: id.

list_all_zendesk_help_center_posts

List community posts in Zendesk Help Center. Returns: id, title, status, details, vote_count, created_at, updated_at.

get_single_zendesk_help_center_post_by_id

Get a single community post in Zendesk Help Center by id. Returns: id, title, status, details, vote_count, created_at, updated_at. Required: id.

list_all_zendesk_help_center_post_comments

List all comments on a Zendesk Help Center community post. Returns: id, body, author_id, official, vote_count, vote_sum, created_at, updated_at. Required: post_id.

get_single_zendesk_help_center_post_comment_by_id

Get a single comment on a Zendesk Help Center community post by id. Returns: id, body, author_id, official, vote_count, vote_sum, created_at, updated_at. Required: post_id, id.

delete_a_zendesk_help_center_post_comment_by_id

Delete a comment on a community post in Zendesk Help Center. Returns an empty 204 response on success. Required: post_id, id.

update_a_zendesk_help_center_post_comment_by_id

Update a comment on a community post in Zendesk Help Center. Returns the updated post comment including id, body, author_id, post_id, and created_at. Required: id, post_id, comment.

list_all_zendesk_help_center_topics

List community topics in Zendesk Help Center. Returns: created_at, description, follower_count, html_url, id, manageable_by, name, position, updated_at, url, user_segment_id.

get_single_zendesk_help_center_topic_by_id

Get a community topic in Zendesk Help Center by id. Returns: created_at, description, follower_count, html_url, id, manageable_by, name, position, updated_at, url, user_segment_id. Required: id.

list_all_zendesk_help_center_category_articles

List the articles in a Help Center category in Zendesk. Returns: id, url, html_url, title, body, locale, source_locale, author_id, comments_disabled, draft, promoted, position, vote_sum, vote_count, label_names, edited_at, created_at, updated_at, and 4 more. Required: category_id. Supports sorting by position, title, created_at, or updated_at.

list_all_zendesk_help_center_section_articles

List articles in a Zendesk Help Center section, sortable by position, title, created_at, or updated_at. Returns: id, title, body, locale, created_at, updated_at. Required: section_id.

create_a_zendesk_help_center_section_article

Create an article in a section of a Zendesk Help Center. Returns the created article with id, title, body, author_id, html_url, created_at, and vote_count. Required: locale, section_id, article.

list_all_zendesk_help_center_user_articles

List the Help Center articles authored by a specific user in Zendesk. Returns: id, title, author_id, locale, html_url, created_at, updated_at. Required: user_id.

list_all_zendesk_help_center_users

List users in Zendesk Help Center. Returns: id, created_at, updated_at. Max 100 per page.

list_all_zendesk_help_center_search_articles

Search Zendesk Help Center articles by a search string. Returns matching article records including id, result_type, snippet, created_at, and updated_at; the snippet delimits matching words with tags and results are sorted by relevance by default. Required: search_string. Max 100 per page, up to 1000 results.

list_all_zendesk_help_center_search_posts

Search Help Center community posts in Zendesk by a search string. Returns: id, created_at, updated_at. Required: search_string. Results are sorted by relevance by default; max 25 posts per page, up to 1000 results.

zendesk_help_center_files_download

Download a file from Zendesk Help Center by its path. Returns the raw file content; the response shape depends on the file's content type. Required: path.

list_all_zendesk_help_center_article_content

Get a single article in Zendesk Help Center by id. Returns the full article object including id, title, body, author_id, locale, html_url, draft, vote_count, and created_at. Required: page_id.

list_all_zendesk_help_center_post_content

Get a specific community post in Zendesk Help Center by its page id. Returns: author_id, closed, comment_count, content_tag_ids, created_at, details, featured, follower_count, html_url, id, non_author_editor_id, non_author_updated_at, pinned, status, title, topic_id, updated_at, url, vote_count, vote_sum. Required: page_id.

list_all_zendesk_help_center_search

Perform a unified search across Zendesk Help Center content, including federated external content sources. Returns matching results with title, type, updated_at, and url. Required: filter.locales to limit the search to specific locales (e.g. en-us,en-gb).

list_all_zendesk_help_center_topic_posts

List community posts in a Zendesk Help Center topic. Returns: author_id, closed, comment_count, content_tag_ids, created_at, details, featured, follower_count, html_url, id, non_author_editor_id, non_author_updated_at, pinned, status, title, topic_id, updated_at, url, vote_count, vote_sum. Required: topic_id.

delete_a_zendesk_help_center_article_subscription_by_id

Delete a Zendesk Help Center article subscription by id, removing the specified subscription from the specified article. Returns an empty 204 response on success. Required: article_id, id.

get_single_zendesk_help_center_article_subscription_by_id

Get a single subscription to a Zendesk Help Center article by id. Returns: content_id, content_type, created_at, id, include_comments, locale, source_locale, updated_at, url, user_id. Required: article_id, id.

list_all_zendesk_help_center_article_subscriptions

List the subscriptions to a Zendesk Help Center article. Returns: content_id, content_type, created_at, id, include_comments, locale, source_locale, updated_at, url, user_id. Required: article_id.

create_a_zendesk_help_center_article_up

Create an upvote for a Zendesk Help Center article. Returns the created or updated vote record including its id and the remaining vote fields defined upstream (under attributes); if a vote already exists for the article it is updated rather than duplicated. Required: article_id.

list_all_zendesk_help_center_article_votes

List votes on a Help Center article in Zendesk. Returns: created_at, id, item_id, item_type, updated_at, url, user_id, value. Required: article_id.

get_single_zendesk_help_center_article_attachment_by_id

Get a single article attachment in Zendesk Help Center by id. Shows the properties of the specified attachment. Returns: id, article_id, file_name, content_url, content_type, size, inline, locale, created_at, updated_at. Required: id.

create_a_zendesk_help_center_comment_down

Create (or update) a downvote on a Zendesk Help Center post comment. Returns the vote record including its id, created_at, and updated_at. Required: post_id, comment_id. If a vote already exists for the post comment, it is updated.

create_a_zendesk_help_center_comment_downs_down

Create a downvote for an article comment in Zendesk Help Center, updating any existing vote on the comment. Returns: created_at, id, item_id, item_type, updated_at, url, user_id, value. Required: article_id, comment_id.

create_a_zendesk_help_center_comment_up

Upvote a post comment in Zendesk Help Center. Creates the upvote, or updates the existing vote if one is already cast. Returns the created vote object, including its id. Required: post_id, comment_id.

create_a_zendesk_help_center_comment_ups_up

Create an upvote for an article comment in Zendesk Help Center; if a vote already exists for the comment, it is updated instead. Returns the vote record including its id, value, user_id, and created_at timestamps. Required: article_id, comment_id.

zendesk_help_center_community_posts_attach_comment

Add a comment to a community post in Zendesk Help Center. Returns the created comment object with id, author_id, created_at, and updated_at. Required: post_id, comment.

zendesk_help_center_community_posts_attach_subscription

Create a subscription to a community post in Zendesk Help Center. Returns the created subscription object with id, user_id, created_at, and updated_at. Required: post_id.

create_a_zendesk_help_center_community_post

Create a community post in a Zendesk Help Center topic. Returns the created post object with id, author_id, created_at, and updated_at. Required: post.

delete_a_zendesk_help_center_community_post_by_id

Delete a community post in Zendesk Help Center by id. Returns an empty 204 response on success. Required: id.

zendesk_help_center_community_posts_list_subscriptions

List subscriptions to a community post in Zendesk Help Center. Returns: id, user_id, content_id, locale, created_at. Required: post_id. For end users, only subscriptions created by the requesting end-user are returned.

zendesk_help_center_community_posts_list_votes

List all votes cast by users for a specific community post in Zendesk Help Center. Returns: id, value, user_id, item_id, item_type, created_at, updated_at, url. Required: post_id.

update_a_zendesk_help_center_community_post_by_id

Update a community post in Zendesk Help Center by id. Returns the updated post with id, author_id, edited_at, created_at, and updated_at. Required: id.

zendesk_help_center_community_topics_attach_subscription

Subscribe a user to a community topic in Zendesk Help Center. Returns the created subscription's id. Required: topic_id.

create_a_zendesk_help_center_community_topic

Create a community topic in Zendesk Help Center. Returns: created_at, description, follower_count, html_url, id, manageable_by, name, position, updated_at, url, user_segment_id. Required: topic.

delete_a_zendesk_help_center_community_topic_by_id

Delete a community topic in Zendesk Help Center by id. Returns an empty 204 response on success. Required: id.

zendesk_help_center_community_topics_list_subscriptions

List subscriptions to a Zendesk Help Center community topic. Returns: id, content_id, content_type, user_id, include_comments, locale, created_at. Required: topic_id. End-user requests return only their own subscriptions.

update_a_zendesk_help_center_community_topic_by_id

Update a community topic in Zendesk Help Center by id. Returns: created_at, description, follower_count, html_url, id, manageable_by, name, position, updated_at, url, user_segment_id. Required: id, topic.

list_all_zendesk_help_center_community_users

List the community post comments created by a specific user in Zendesk Help Center; pass 'me' as user_id to list the requesting user's own comments. Returns: id, attributes (post-comment fields). Required: user_id. Max 100 records per page.

create_a_zendesk_help_center_guide_user_image

Create the image path for an uploaded community-post image in Zendesk Guide. Returns the image path that can be used to display the image in a community post; the source docs do not enumerate the response fields. Required: token, brand_id. Only call after the image has been uploaded via the upload URL.

zendesk_help_center_help_center_articles_attach_attachment

Attach a Guide media object as an attachment to a Help Center article. Returns: id, guide_media_id, inline, locale, created_at, updated_at. Required: article_id, guide_media_id.

zendesk_help_center_help_center_articles_attach_comment

Add a comment to a Help Center article. Returns: id, locale, created_at, updated_at. Required: article_id.

zendesk_help_center_help_center_articles_attach_label

Attach a new label to a Help Center article. Returns: id, created_at, updated_at. Required: article_id.

create_a_zendesk_help_center_help_center_article

Create a label on a Help Center article for a specific locale. Returns: created_at, id, name, updated_at, url. Required: locale, article_id.

delete_a_zendesk_help_center_help_center_article_by_id

Archive a Zendesk Help Center article by id; archived articles can be restored later from the Help Center UI. Returns an empty 204 response on success. Required: id, locale.

get_single_zendesk_help_center_help_center_article_by_id

Get a single Zendesk Help Center article in a specific locale by id. Returns: id, title, body, html_url, author_id, created_at, updated_at, vote_count. Required: id, locale.

list_all_zendesk_help_center_help_center_articles

List Zendesk Help Center articles in a locale, sortable by position, title, created_at, or updated_at, with optional label filtering. Returns: id, title, body, html_url, author_id, created_at, updated_at, vote_count. Required: locale.

zendesk_help_center_help_center_articles_list_attachments

List a Zendesk Help Center article's attachments for a given locale. Returns attachment records including id and inline. Required: locale, article_id. Max 100 attachments per page.

zendesk_help_center_help_center_articles_list_comments

List the comments on a Zendesk Help Center article in a given locale. Returns: id, body, author_id, html_url, created_at, updated_at, vote_count. Required: article_id, locale.

zendesk_help_center_help_center_articles_list_labels

List the labels for a Zendesk Help Center article in the given locale. Returns: id, name, created_at, updated_at, url. Required: locale, article_id.

zendesk_help_center_help_center_articles_list_subscriptions

List the subscriptions to a Zendesk Help Center article in the given locale. Returns: id, content_id, user_id, include_comments, locale, created_at, updated_at, url. Required: locale, article_id.

zendesk_help_center_help_center_articles_list_votes

List all votes cast by users on a Zendesk Help Center article in the given locale. Returns: id, user_id, value, item_id, item_type, created_at, updated_at, url. Required: locale, article_id.

update_a_zendesk_help_center_help_center_article_by_id

Update an article in the Zendesk Help Center by locale. Returns the updated article object including its id and locale-specific content attributes. Required: id, locale.

list_all_zendesk_help_center_help_center_articles_attachments

List all attachments of an article in Zendesk Help Center. Returns each attachment's id, article_id, inline, guide_media_id, locale, created_at, and updated_at. Required: article_id. Max 100 per page.

create_a_zendesk_help_center_help_center_articles_comment

Create a comment on a Help Center article in Zendesk. Because comments are tied to a specific article translation, you must specify a locale. Returns the created comment's id, created_at, and updated_at. Requires locale, article_id, and a comment object. Required: locale, article_id, comment.

list_all_zendesk_help_center_help_center_articles_labels

List labels for a Zendesk Help Center article. Returns: created_at, id, name, updated_at, url. Required: article_id.

create_a_zendesk_help_center_help_center_articles_subscription

Create a subscription to a Zendesk Help Center article for the current user. Returns the created subscription with id, user_id, created_at, and updated_at. Required: article_id.

create_a_zendesk_help_center_post_down

Create a downvote on a Zendesk Help Center community post; if the user already voted on the post, the existing vote is updated instead. Returns the vote record: id, attributes. Required: post_id.

delete_a_zendesk_help_center_post_subscription_by_id

Delete a subscription to a given post in Zendesk Help Center. Returns an empty 204 response on success. Required: post_id, id.

get_single_zendesk_help_center_post_subscription_by_id

Get a post subscription in Zendesk Help Center by id. Returns: id, user_id, content_id, include_comments, locale, created_at, updated_at. Required: post_id, id. End users receive only subscriptions they created themselves.

create_a_zendesk_help_center_post_up

Upvote a post in Zendesk Help Center. Creates an upvote for the given post, or updates the existing vote if the user already voted on it. Returns the vote record including its id, value, user_id, item_id, and created_at. Required: post_id.

delete_a_zendesk_help_center_topic_subscription_by_id

Delete a topic subscription in Zendesk Help Center by id, removing the subscription to the given topic. Returns an empty 204 response on success. Required: id, topic_id.

get_single_zendesk_help_center_topic_subscription_by_id

Get a topic subscription in Zendesk Help Center by its id. Returns: id, content_id, user_id, include_comments, locale, created_at. Required: topic_id, id. End users can only retrieve subscriptions they created.

update_a_zendesk_help_center_topic_subscription_by_id

Update a topic subscription in Zendesk Help Center by id. Returns the subscription object including id, user_id, topic_id, created_at, and updated_at. Required: id, topic_id.

create_a_zendesk_help_center_user_images_upload

Create an upload URL and token for a Zendesk Help Center user image; upload the image bytes with a PUT to the returned url (max 2MB), then use the token to create the image path. Returns: url, headers, token. Required: content_type, file_size.

list_all_zendesk_help_center_user_posts

List community posts created by a specific user in Zendesk Help Center. Returns: id, title, details, status, created_at, updated_at, vote_count, comment_count. Required: user_id.

get_single_zendesk_help_center_post_comments_post_by_id

Get a single community post comment in a requested locale in Zendesk Help Center. Returns: id, locale, author_id, created_at, updated_at. Required: locale, post_id, id.

list_all_zendesk_help_center_post_comments_votes

List votes on a comment of a Zendesk Help Center community post. Returns each vote with id, value, user_id, item_type, and created_at. Required: post_id, comment_id.

create_a_zendesk_help_center_article_bulk_attachment

Associate existing Help Center attachments to an article in bulk. Returns an empty 204 response on success. Max 20 attachments per request, one article at a time; create the attachments first via the unassociated-attachments endpoint. Required: article_id, attachment_ids.

create_a_zendesk_help_center_article_bulk_attachments_article

Associate up to 20 uncreated attachments in bulk to a single Zendesk Help Center article by locale. Returns an empty 200 response on success. Required: locale, article_id. Maximum 20 attachments per request; create the attachments first via the unassociated attachment endpoint.

delete_a_zendesk_help_center_article_comments_article_by_id

Delete an article comment in Zendesk Help Center, identified by id within the given article. Allowed for agents and the end user who created the comment. Returns an empty 204 response on success. Required: locale, article_id, id.

get_single_zendesk_help_center_article_comments_article_by_id

Get a specific comment on a Zendesk Help Center article by locale. Returns the comment's id, body, author_id, html_url, locale, created_at, vote_count, and vote_sum. Required: locale, article_id, and id.

update_a_zendesk_help_center_article_comments_article_by_id

Update an article comment in Zendesk Help Center, identified by id within the given article. Returns the updated comment including its id, body, and locale. Required: locale, article_id, id.

list_all_zendesk_help_center_article_comments_votes

List votes on a specific Help Center article comment in Zendesk. Returns each vote's id, value, user_id, item_id, item_type, url, created_at, and updated_at. Required: locale, article_id, comment_id.

delete_a_zendesk_help_center_article_label_by_id

Remove a label from a Zendesk Help Center article. Returns an empty 204 response on success. Required: id, article_id.

delete_a_zendesk_help_center_article_labels_article_by_id

Remove a label from a Zendesk Help Center article in the specified locale, deleting it from that article's list of labels. Returns an empty 204 response on success. Required: id, locale, article_id.

zendesk_help_center_article_source_locales_bulk_update

Set one of a Zendesk Help Center article's translations as its source locale; the article in the previous source locale becomes a translation you can delete separately. Returns an empty 204 response on success. Required: article_id. The new source locale must be enabled in Guide.

zendesk_help_center_article_source_locales_bulk_update_version

Set one of a Zendesk Help Center article's translations as its source locale via the locale-scoped route; the article in the previous source locale becomes a translation you can delete separately. Returns an empty 204 response on success. Required: locale, article_id. The new source locale must be enabled in Guide.

delete_a_zendesk_help_center_article_subscriptions_article_by_id

Delete an article subscription in Zendesk Help Center, removing the specified subscription from a specific article in the given locale. Returns an empty 204 response on success. Required: locale, article_id, id.

get_article_subscriptions_article_by_id

Get a specific subscription to a Zendesk Help Center article by locale. Returns: content_id, content_type, created_at, id, include_comments, locale, source_locale, updated_at, url, user_id. Required: locale, article_id, and id.

get_single_zendesk_help_center_attachments_block_by_id

List the block attachments (those that are not inline) of a Help Center article, scoped by locale. Returns: id, file_name, content_url, inline, created_at, updated_at. 'en-us'). Required: id, locale.

list_all_zendesk_help_center_attachments_blocks

List the block attachments (those that are not inline) of a Help Center article. Returns: id, file_name, content_url, inline, created_at, updated_at. Required: article_id.

get_single_zendesk_help_center_attachments_inline_by_id

List the inline attachments of a Zendesk Help Center article for a specific locale. Returns each attachment's id, inline flag, created_at, and updated_at. Required: id, locale.

list_all_zendesk_help_center_attachments_inlines

List the inline attachments of a Zendesk Help Center article. Returns each attachment's id, inline flag, created_at, and updated_at. Required: article_id.

list_all_zendesk_help_center_categorie_articles

List articles in a Zendesk Help Center category by locale. Returns: id, title, html_url, position, promoted, draft, created_at, updated_at. Required: locale, category_id.

create_a_zendesk_help_center_categorie_section

Create a section in a Zendesk Help Center category. Returns the created section with its id, name, description, locale, category_id, and created_at. Optionally supply additional translations for locales enabled in the Help Center. Required: category_id, section.

list_all_zendesk_help_center_categorie_sections

List the sections in a specific category and locale in Zendesk Help Center. Returns: id, name, locale, html_url, position, created_at, updated_at. Required: locale, category_id. Only sections the requesting user can view in the help center are returned.

create_a_zendesk_help_center_help_center_category

Create a category in a Zendesk Help Center locale. Returns the created category object including id, name, locale, source_locale, position, and created_at. Required: locale, name.

delete_a_zendesk_help_center_help_center_category_by_id

Delete a Zendesk Help Center category by id. Every section and all articles in the category are also deleted. Returns an empty 204 response on success. Required: id and locale.

get_single_zendesk_help_center_help_center_category_by_id

Get a single category in Zendesk Help Center by locale. Returns the full category object including id, name, description, html_url, position, source_locale, created_at, and updated_at. Required: locale, id.

list_all_zendesk_help_center_help_center_categories

List categories in Zendesk Help Center for a given locale. Returns: created_at, description, html_url, id, locale, name, outdated, position, source_locale, updated_at, url. Required: locale. Max 100 per page.

update_a_zendesk_help_center_help_center_category_by_id

Update category-level metadata (such as the sorting position) on a Zendesk Help Center category. Returns: created_at, description, html_url, id, locale, name, outdated, position, source_locale, updated_at, url. Does not update category translations. Required: id, locale.

create_a_zendesk_help_center_article_down

Create a downvote on a Help Center article — if a vote already exists for the article, it is updated instead. Returns the vote record with its id, created_at, and updated_at. Required: article_id.

create_a_zendesk_help_center_article_translation

Create a new translation for a Zendesk Help Center article. Returns the created translation object with id, locale, draft, outdated, created_at, and updated_at. The locale must be enabled for the Help Center and differ from any existing translation's locale. Required: article_id, locale.

list_all_zendesk_help_center_article_translations

List all translations for a Zendesk Help Center article. Returns: id, locale, title, body, html_url, draft, outdated, created_at, updated_at. Required: article_id.

update_a_zendesk_help_center_article_translation_by_id

Update an article translation in Zendesk Help Center for a given locale. Returns the updated translation object with id, locale, draft, outdated, created_at, and updated_at. The translation's updated_at is not changed when the request body matches the existing data. Required: article_id, locale.

list_all_zendesk_help_center_articles_embeddable_searches

Search Zendesk Help Center articles optimized for embeddable widget contexts. Returns: result_type, results, snippet. Requires at least one of query, category, section, or label_names. Max 100 per page.

create_a_zendesk_help_center_categorie_translation

Create a translation for a Zendesk Help Center category. Returns the created translation object including its id, locale, draft, outdated, and updated_at. Required: category_id, locale. The locale must be enabled for the Help Center and differ from any existing translation of the category.

list_all_zendesk_help_center_categorie_translations

List all translations for a Zendesk Help Center category. Returns: id, title, locale, body, draft, outdated, created_at, updated_at. Required: category_id. End users see only translations for categories they can view.

update_a_zendesk_help_center_categorie_translation_by_id

Update a translation of a Zendesk Help Center category identified by category_id and locale. Returns the updated translation object including its id, locale, draft, outdated, and updated_at. Required: category_id, locale. updated_at is not changed when the request data matches the stored translation.

list_all_zendesk_help_center_deflection_suggestions

List suggested articles in Zendesk Help Center matching a search query, sorted by relevance. Returns: results. Required: query (max 200 characters).

list_all_zendesk_help_center_help_center_locales

List the enabled locales and the default locale for a Zendesk Help Center. Returns the enabled locale identifiers along with the Help Center's default locale.

zendesk_help_center_help_center_sections_attach_subscription

Create a subscription to a section in the Zendesk Help Center. Returns the created subscription with its id, user_id, include_comments, and created_at. Required: locale, section_id.

delete_a_zendesk_help_center_help_center_section_by_id

Delete a section in the Zendesk Help Center by id. All articles in the section will also be deleted. Returns an empty 204 response on success. Required: id and locale.

get_single_zendesk_help_center_help_center_section_by_id

Get a single section by id in a Zendesk Help Center locale. Returns the section object including id, name, locale, position, category_id, html_url, and created_at/updated_at timestamps. Required: id, locale.

list_all_zendesk_help_center_help_center_sections

List all sections in a Zendesk Help Center locale. Returns sections with id, name, locale, position, category_id, html_url, and created_at/updated_at timestamps. Required: locale.

update_a_zendesk_help_center_help_center_section_by_id

Update a section in Zendesk Help Center by locale. Returns the updated section including id, name, locale, position, category_id, parent_section_id, html_url, created_at, and updated_at. Requires id, locale, and section. Updates section-level fields only; use Translations for non-source locales. Required: id, locale, section.

list_all_zendesk_help_center_incremental_articles

List Zendesk Help Center articles incrementally, returning all articles updated since a given start_time (epoch seconds). Returns: id, title, body, html_url, section_id, locale, author_id, created_at, updated_at, vote_sum.

zendesk_help_center_section_source_locales_bulk_update

Update a section's source locale in Zendesk Help Center, setting the section's source language to something other than the Help Center default (for example, 'ja' for a section that only serves Japanese customers). Returns an empty 204 response on success. Required: section_id.

zendesk_help_center_section_source_locales_bulk_update_version

Update a section's source locale in Zendesk Help Center for a specific locale, setting the section's source language to something other than the Help Center default (for example, 'ja' for a section that only serves Japanese customers). Returns an empty 204 response on success. Required: locale, section_id.

create_a_zendesk_help_center_section_translation

Create a translation for a section in Zendesk Help Center. Returns the created translation object with id, locale, outdated and draft status, and created_at/updated_at timestamps. Required: section_id, locale. The locale must be enabled for the Help Center and must differ from any existing translation of the section.

list_all_zendesk_help_center_section_translations

List all translations for a Zendesk Help Center section. Returns: id, locale, title, body, html_url, draft, outdated, created_at, updated_at. Required: section_id. For end users, only translations of sections they can view are returned.

update_a_zendesk_help_center_section_translation_by_id

Update a section translation in Zendesk Help Center by section_id and locale. Returns the updated translation object with id, locale, outdated and draft status, and created_at/updated_at timestamps. Required: section_id, locale. updated_at is not changed when the request data matches the existing translation.

get_single_zendesk_help_center_section_subscription_by_id

Get a section subscription by id for a specific locale in Zendesk Help Center. Returns: id, content_id, content_type, user_id, include_comments, locale, created_at, updated_at, url. Required: locale, section_id, id.

delete_a_zendesk_help_center_section_subscription_by_id

Delete a section subscription from a specific section in Zendesk Help Center. Returns an empty 204 response on success. Required: id, locale, section_id.

get_single_zendesk_help_center_translations_missing_by_id

List the locales that don't have a translation for a Zendesk Help Center article. Returns an array of missing locale codes for the article. Required: id.

delete_a_zendesk_help_center_articles_label_by_id

Delete a label in Zendesk Help Center by id, removing it from all articles. Returns an empty 204 response on success. Required: id.

get_categorie_translations_missing_by_id

List the locales for which a Zendesk Help Center category has no translation yet. Returns the list of missing locale codes so you can target the translations to create next. Required: id.

get_section_translations_missing_by_id

List the locales missing a translation for a Help Center section in Zendesk. Returns an array of locale codes that have no translation for the section yet. Required: id.

create_a_zendesk_help_center_application_access_request

Create an access request for an application in Zendesk Help Center on the caller's behalf, backed by a Classic ticket. Returns: application_id, application_name, business_justification, status, ticket_id. Requires application_id and business_justification. Required: application_id, business_justification.

create_a_zendesk_help_center_articles_attachment

Create an unassociated article attachment in Zendesk Help Center for bulk imports — upload a file without associating it to an article until later. Returns the attachment's id, locale, guide_media_id, inline flag, and created_at. Requires guide_media_id (the id of a Guide media object created beforehand); set locale in advance if the attachment…

delete_a_zendesk_help_center_articles_attachment_by_id

Delete an article attachment in Zendesk Help Center by id. Returns an empty 204 response on success. Required: id.

list_all_zendesk_help_center_articles_featureds

List featured articles configured in Zendesk Help Center search settings. Returns: breadcrumbs, multibrand, stripped_title, title, url.

create_a_zendesk_help_center_help_center_user_segment

Create a user segment in Zendesk Help Center. Returns: added_user_ids, built_in, created_at, group_ids, id, name, or_tags, organization_ids, tags, updated_at, user_type.

delete_a_zendesk_help_center_help_center_user_segment_by_id

Delete a user segment in Zendesk Help Center by id. Returns an empty 204 response on success. Required: id.

get_single_zendesk_help_center_help_center_user_segment_by_id

Get a single Zendesk Help Center user segment by id. Returns: added_user_ids, built_in, created_at, group_ids, id, name, or_tags, organization_ids, tags, updated_at, user_type. Required: id.

list_all_zendesk_help_center_help_center_user_segments

List Zendesk Help Center user segments. Returns each segment's id, name, user_type, built_in, group_ids, organization_ids, tags, created_at, and updated_at. Supports cursor pagination.

update_a_zendesk_help_center_help_center_user_segment_by_id

Update a user segment in Zendesk Help Center by id. Returns: added_user_ids, built_in, created_at, group_ids, id, name, or_tags, organization_ids, tags, updated_at, user_type. Required: id.

get_single_zendesk_help_center_service_catalog_item_by_id

Get a single Zendesk Help Center service catalog item by id. Returns the service_catalog_item object, including its id and the remaining item fields defined upstream. Required: id.

list_all_zendesk_help_center_service_catalog_items

List all Zendesk Help Center service catalog items available. Returns: count, links, meta, service_catalog_items.

zendesk_help_center_service_catalog_items_search

Search Zendesk Help Center service catalog items matching a search query; results are returned sorted by relevancy. Returns: count, links, meta, service_catalog_items.

create_a_zendesk_help_center_user_user_subscription

Create a user subscription for a user in Zendesk Help Center, making them follow another user. Returns: id, followed_id, follower_id. Requires user_id and a user_subscription with followed_id. Specify me as the user_id to create your own; an existing subscription is updated in place. Required: user_id, user_subscription.

delete_a_zendesk_help_center_user_user_subscription_by_id

Delete a user subscription for a specified user in Zendesk Help Center. To remove your own subscription, specify `me` as the user id. Returns an empty 204 response on success. Required: user_id, id.

list_all_zendesk_help_center_user_user_subscriptions

List the user subscriptions of a given user in Zendesk Help Center. Returns: id, followed_id, follower_id. Requires user_id; specify me as the user_id to list your own subscriptions. Required: user_id.

get_single_zendesk_help_center_access_requests_latest_by_id

Get the caller's most recent unfinished access request for a Zendesk Help Center application. Returns: application_id, application_name, business_justification, created_at, description, id, requester_id, status, subject. Required: id. Returns 404 when no unfinished request exists for the application.

get_single_zendesk_help_center_application_access_status_by_id

Get the caller's own access status for an application in Zendesk Help Center. Returns: access_evidence, access_status, has_access, role. Required: id. Deleted, hidden, or nonexistent applications return has_access false instead of a 404.

list_all_zendesk_help_center_applications_filters

List the filter dimensions and their selectable options that the Zendesk Help Center applications page renders, in display order. Returns a service-defined payload proxied from the saas-management service whose per-dimension fields are not enumerated in the upstream documentation. Requests fail when the saas-management feature is disabled for the…

create_a_zendesk_help_center_article_ups_up

Create an upvote for a Zendesk Help Center article; if a vote already exists for the article, it is updated. Returns: created_at, id, item_id, item_type, updated_at, url, user_id, value. Required: locale, article_id.

create_a_zendesk_help_center_categorie_sections_category

Create a section in a category in the Zendesk Help Center. Returns the created section including id, name, position, category_id, and locale. Required: locale, category_id, section.

zendesk_help_center_categorie_source_locales_bulk_update

Update a category's source_locale property in Zendesk Help Center. Returns an empty 204 response on success. Required: category_id.

zendesk_help_center_categorie_source_locales_bulk_update_version

Update a Zendesk Help Center category's source_locale to the specified locale. Returns an empty 204 response on success. Required: locale and category_id.

list_all_zendesk_help_center_help_center_sections_subscriptions

List subscriptions to a Zendesk Help Center section, scoped by locale. Returns each subscription's id, user_id, content_id, include_comments, locale, source_locale, url, and created_at. Required: locale, section_id.

list_all_zendesk_help_center_help_center_sessions

Get the current Help Center session in Zendesk. Returns the active session details under current_session.

delete_a_zendesk_help_center_help_center_translation_by_id

Delete a Zendesk Help Center translation by id. Returns an empty 204 response on success. Required: id. The translation cannot be deleted if it is the only translation for its source object.

list_all_zendesk_help_center_help_center_users

List the article comments created by a specific Zendesk Help Center user. Returns: id, author_id, body, locale, created_at, vote_count. Required: user_id.

zendesk_help_center_help_center_users_list_subscriptions

List the content subscriptions of a specific Zendesk Help Center user across articles, sections, questions, and topics. Returns: id, content_id, content_type, locale, include_comments, created_at. Required: user_id.

zendesk_help_center_help_center_users_list_votes

List all votes cast by a specific Zendesk Help Center user on articles, comments, posts, or post comments. Returns: id, user_id, item_id, item_type, value, created_at. Required: user_id.

delete_a_zendesk_help_center_help_center_vote_by_id

Delete a vote in Zendesk Help Center by id. Returns an empty 204 response on success. Required: id.

get_single_zendesk_help_center_help_center_vote_by_id

Get a specific vote in Zendesk Help Center by id. Returns the vote including id, value, user_id, item_id, item_type, and created_at. Required: id.

list_all_zendesk_help_center_help_center_votes

List all votes in Zendesk Help Center. Returns vote records including id, value, user_id, item_id, item_type, and created_at.

list_all_zendesk_help_center_section_articles_sections

List articles in a specific Zendesk Help Center section for a given locale. Returns: author_id, body, comments_disabled, content_tag_ids, created_at, downvote_count, draft, edited_at, html_url, id, label_names, locale, outdated, outdated_locales, permission_group_id, position, title, updated_at, vote_sum, and 8 more. Required: locale, section_id.

list_all_zendesk_help_center_user_segment_sections

List the Zendesk Help Center sections that use a specified user segment. Returns each section's id, name, html_url, locale, position, created_at, and updated_at. Required: user_segment_id.

list_all_zendesk_help_center_user_segment_topics

List the Zendesk Help Center topics that use the specified user segment. Returns: id, name, description, position, follower_count, html_url, created_at, updated_at. Required: user_segment_id.

list_all_zendesk_help_center_user_segments_applicables

List the user segments in Zendesk Help Center that are applicable on the account's current Suite plan. Returns: id, name, user_type, built_in, group_ids, tags, created_at.

list_all_zendesk_help_center_user_user_segments

List the Zendesk Help Center user segments a particular user belongs to. Returns: id, name, user_type, built_in, group_ids, tags, created_at, updated_at. Required: user_id. When an agent requests another user's id, only segments the requesting agent also belongs to are returned.

get_single_zendesk_help_center_hc_application_by_id

Get a single application from the employee-facing catalog in Zendesk Help Center by id. Returns: categories, classification, description, external_id, hero_image_url, homepage, icon_url, id, last_synced_at, long_description, name, origin, provider, source, status, tags. Required: id. A 404 also covers applications hidden from employees.

list_all_zendesk_help_center_hc_applications

List the employee-facing application catalog in Zendesk Help Center, including applications synced from the account's identity provider; applications hidden by an admin are excluded. Returns: applications, page, per_page, total_count, total_pages. Max 100 per page.