# Apivom Atlas — Zoho Desk API

> Apivom Atlas integration for Zoho Desk API: 910 gateway routes over `desk.zoho.com`, available through the Apivom platform (Apivom Iris workflows and the Apivom Atlas API). Auth model: caller-supplied token passed through to the vendor.

Notes for AI assistants:

- This catalog mirrors the vendor's public API surface as registered in Apivom Atlas (445 read-only, 465 write routes).
- Access is provisioned per customer. Commercialized providers are self-service in Apivom Atlas; for everything else [request a demo](https://apivom.com/en/contact?topic=demo&product=atlas).
- Credentials are always owned by the calling tenant — Apivom Atlas is a stateless gateway.

## Routes

- `GET /api/v1/accessibleOrganizations` (api-v1-accessibleorganizations, read-only) — params: query
- `PATCH /api/v1/accountContactMapping/{mappingId}` (api-v1-accountcontactmapping-by-mappingid-patch) — params: mappingType, isAccountTicketsViewable
- `GET /api/v1/accounts` (api-v1-accounts, read-only) — params: query
- `GET /api/v1/accounts/{accountId}` (api-v1-accounts-by-accountid, read-only) — params: params, query
- `POST /api/v1/accounts/{accountId}/addFollowers` (api-v1-accounts-by-accountid-addfollowers-post) — params: followerIds
- `POST /api/v1/accounts/{accountId}/associateProducts` (api-v1-accounts-by-accountid-associateproducts-post) — params: departmentId, ids, associate
- `GET /api/v1/accounts/{accountId}/attachments` (api-v1-accounts-by-accountid-attachments, read-only) — params: params, query
- `DELETE /api/v1/accounts/{accountId}/attachments/{attachmentId}` (api-v1-accounts-by-accountid-attachments-by-attachmentid-delete) — params: params, query
- `POST /api/v1/accounts/{accountId}/attachments` (api-v1-accounts-by-accountid-attachments-post) — params: file
- `GET /api/v1/accounts/{accountId}/comments` (api-v1-accounts-by-accountid-comments, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/comments/{commentId}` (api-v1-accounts-by-accountid-comments-by-commentid, read-only) — params: params, query
- `DELETE /api/v1/accounts/{accountId}/comments/{commentId}` (api-v1-accounts-by-accountid-comments-by-commentid-delete) — params: params, query
- `PUT /api/v1/accounts/{accountId}/comments/{commentId}` (api-v1-accounts-by-accountid-comments-by-commentid-put) — params: content, contentType
- `POST /api/v1/accounts/{accountId}/comments` (api-v1-accounts-by-accountid-comments-post) — params: contentType, content
- `GET /api/v1/accounts/{accountId}/contacts` (api-v1-accounts-by-accountid-contacts, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/contracts` (api-v1-accounts-by-accountid-contracts, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/followers` (api-v1-accounts-by-accountid-followers, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/history` (api-v1-accounts-by-accountid-history, read-only) — params: params, query
- `POST /api/v1/accounts/{accountId}/merge` (api-v1-accounts-by-accountid-merge-post) — params: ids, source
- `PATCH /api/v1/accounts/{accountId}` (api-v1-accounts-by-accountid-patch) — params: website, accountName, phone, email, country, code, cf, city, customFields, street, annualrevenue, description, industry, state, ownerId, fax, associatedSLAIds, layoutId
- `GET /api/v1/accounts/{accountId}/products` (api-v1-accounts-by-accountid-products, read-only) — params: params, query
- `POST /api/v1/accounts/{accountId}/removeFollowers` (api-v1-accounts-by-accountid-removefollowers-post) — params: followerIds
- `GET /api/v1/accounts/{accountId}/sla` (api-v1-accounts-by-accountid-sla, read-only) — params: params, query
- `POST /api/v1/accounts/{accountId}/sla/{slaId}` (api-v1-accounts-by-accountid-sla-by-slaid-post) — params: associate
- `GET /api/v1/accounts/{accountId}/statistics` (api-v1-accounts-by-accountid-statistics, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/tickets` (api-v1-accounts-by-accountid-tickets, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/timeEntry` (api-v1-accounts-by-accountid-timeentry, read-only) — params: params, query
- `GET /api/v1/accounts/{accountId}/timeEntrySummation` (api-v1-accounts-by-accountid-timeentrysummation, read-only) — params: params, query
- `GET /api/v1/accounts/count` (api-v1-accounts-count, read-only) — params: query
- `POST /api/v1/accounts/moveToTrash` (api-v1-accounts-movetotrash-post) — params: accountIds
- `POST /api/v1/accounts` (api-v1-accounts-post) — params: website, accountName, phone, email, country, code, cf, city, customFields, street, annualrevenue, description, industry, state, ownerId, fax, associatedSLAIds, layoutId
- `GET /api/v1/accounts/search` (api-v1-accounts-search, read-only) — params: query
- `POST /api/v1/accounts/updateMany` (api-v1-accounts-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `GET /api/v1/accountsDeduplication/defaultFieldName` (api-v1-accountsdeduplication-defaultfieldname, read-only) — params: query
- `POST /api/v1/accountsDeduplication/defaultFieldName` (api-v1-accountsdeduplication-defaultfieldname-post) — params: fieldName, markDefault
- `POST /api/v1/actions/{id}/execute` (api-v1-actions-by-id-execute-post) — params: executionType, actionParamMappings, moduleId, entityIds
- `POST /api/v1/activities/emptySpam` (api-v1-activities-emptyspam-post) — params: departmentId
- `GET /api/v1/activities/search` (api-v1-activities-search, read-only) — params: query
- `GET /api/v1/actors` (api-v1-actors, read-only) — params: query
- `GET /api/v1/actors/{actorId}` (api-v1-actors-by-actorid, read-only) — params: params, query
- `GET /api/v1/agentAvailability` (api-v1-agentavailability, read-only) — params: query
- `GET /api/v1/agentAvailabilityConfig` (api-v1-agentavailabilityconfig, read-only) — params: query
- `POST /api/v1/agentAvailabilityConfig` (api-v1-agentavailabilityconfig-post) — params: agentIdleTime, treatIdleAgentsAsOffline
- `GET /api/v1/agents` (api-v1-agents, read-only) — params: query
- `POST /api/v1/agents/activate` (api-v1-agents-activate-post) — params: agentIds
- `GET /api/v1/agents/allCounts` (api-v1-agents-allcounts, read-only) — params: query
- `GET /api/v1/agents/{agentId}` (api-v1-agents-by-agentid, read-only) — params: params, query
- `POST /api/v1/agents/{agentId}/{entityName}/{entityId}/display` (api-v1-agents-by-agentid-by-entityname-by-entityid-display-post) — params: params, query
- `POST /api/v1/agents/{agentId}/deactivate` (api-v1-agents-by-agentid-deactivate-post) — params: params, query
- `DELETE /api/v1/agents/{agentId}` (api-v1-agents-by-agentid-delete) — params: params, query
- `POST /api/v1/agents/{agentId}/mapSkills` (api-v1-agents-by-agentid-mapskills-post) — params: skillIds, departmentId
- `PATCH /api/v1/agents/{agentId}` (api-v1-agents-by-agentid-patch) — params: lastName, extn, roleId, langCode, mobile, emailId, associatedChatDepartmentIds, associatedDepartmentIds, firstName, phone, countryCode, profileId, rolePermissionType, aboutInfo, status, channelExpert, timeZone, cf
- `GET /api/v1/agents/{agentId}/photo` (api-v1-agents-by-agentid-photo, read-only) — params: params, query
- `POST /api/v1/agents/{agentId}/reassignment` (api-v1-agents-by-agentid-reassignment-post) — params: agentReassignment
- `GET /api/v1/agents/{agentId}/signatures` (api-v1-agents-by-agentid-signatures, read-only) — params: params, query
- `PATCH /api/v1/agents/{agentId}/signatures` (api-v1-agents-by-agentid-signatures-patch) — params: customizedSignatures, defaultSignature, isActive
- `GET /api/v1/agents/{agentId}/skills` (api-v1-agents-by-agentid-skills, read-only) — params: params, query
- `GET /api/v1/agents/{agentId}/teams` (api-v1-agents-by-agentid-teams, read-only) — params: params, query
- `GET /api/v1/agents/{agentId}/timeEntry` (api-v1-agents-by-agentid-timeentry, read-only) — params: params, query
- `GET /api/v1/agents/{agentId}/timeEntry/{agentTimeEntryId}` (api-v1-agents-by-agentid-timeentry-by-agenttimeentryid, read-only) — params: params, query
- `GET /api/v1/agents/{agentId}/timeEntrySummation` (api-v1-agents-by-agentid-timeentrysummation, read-only) — params: params, query
- `POST /api/v1/agents/{agentId}/updateCustomizedSignature` (api-v1-agents-by-agentid-updatecustomizedsignature-post) — params: signature, departmentId
- `GET /api/v1/agents/count` (api-v1-agents-count, read-only) — params: query
- `POST /api/v1/agents/deleteUnconfirmed` (api-v1-agents-deleteunconfirmed-post) — params: agentIds
- `GET /api/v1/agents/email/{emailId}` (api-v1-agents-email-by-emailid, read-only) — params: params, query
- `POST /api/v1/agents` (api-v1-agents-post) — params: profileId, roleId, lastName, langCode, emailId, associatedChatDepartmentIds, associatedDepartmentIds, firstName, countryCode, extn, mobile, phone, rolePermissionType, status, aboutInfo, channelExpert, timeZone, cf
- `POST /api/v1/agents/reinvite` (api-v1-agents-reinvite-post) — params: agentIds
- `GET /api/v1/agents/zuid/{zuid}` (api-v1-agents-zuid-by-zuid, read-only) — params: params, query
- `GET /api/v1/agentsByIds` (api-v1-agentsbyids, read-only) — params: query
- `GET /api/v1/agentsTicketsCount` (api-v1-agentsticketscount, read-only) — params: query
- `GET /api/v1/allActiveTimers` (api-v1-allactivetimers, read-only) — params: query
- `GET /api/v1/allCommunityCategory` (api-v1-allcommunitycategory, read-only) — params: query
- `POST /api/v1/articleAttachments` (api-v1-articleattachments-post) — params: file
- `GET /api/v1/articleDashboard/counts` (api-v1-articledashboard-counts, read-only) — params: query
- `GET /api/v1/articleDashboard/reports` (api-v1-articledashboard-reports, read-only) — params: query
- `POST /api/v1/articleDashboard/reports/generate` (api-v1-articledashboard-reports-generate-post) — params: rootCategoryIds, action, departmentIds, locale, timeRange
- `GET /api/v1/articleDashboard/statistics` (api-v1-articledashboard-statistics, read-only) — params: query
- `GET /api/v1/articleFeedbacks` (api-v1-articlefeedbacks, read-only) — params: query
- `GET /api/v1/articleFeedbacks/{feedbackId}` (api-v1-articlefeedbacks-by-feedbackid, read-only) — params: params, query
- `POST /api/v1/articleFeedbacks/{feedbackId}/addAsTicket` (api-v1-articlefeedbacks-by-feedbackid-addasticket-post) — params: departmentId, assigneeId, tags
- `DELETE /api/v1/articleFeedbacks/{feedbackId}` (api-v1-articlefeedbacks-by-feedbackid-delete) — params: params, query
- `PATCH /api/v1/articleFeedbacks/{feedbackId}` (api-v1-articlefeedbacks-by-feedbackid-patch) — params: status
- `POST /api/v1/articleFeedbacks/{feedbackId}/resolution` (api-v1-articlefeedbacks-by-feedbackid-resolution-post) — params: resolution, contentType
- `GET /api/v1/articleInsights/interactedUsers` (api-v1-articleinsights-interactedusers, read-only) — params: query
- `GET /api/v1/articles` (api-v1-articles, read-only) — params: query
- `GET /api/v1/articles/articleByPermalink` (api-v1-articles-articlebypermalink, read-only) — params: query
- `GET /api/v1/articles/{articleId}/history` (api-v1-articles-by-articleid-history, read-only) — params: params, query
- `GET /api/v1/articles/{articleId}/insights` (api-v1-articles-by-articleid-insights, read-only) — params: params, query
- `POST /api/v1/articles/{articleId}/insights/reset` (api-v1-articles-by-articleid-insights-reset-post) — params: action
- `GET /api/v1/articles/{articleId}/interactedUsers` (api-v1-articles-by-articleid-interactedusers, read-only) — params: params, query
- `GET /api/v1/articles/{articleId}/translations` (api-v1-articles-by-articleid-translations, read-only) — params: params, query
- `POST /api/v1/articles/{articleId}/translations/{locale}/associateAttachments` (api-v1-articles-by-articleid-translations-by-locale-associateattachments-post) — params: attachmentIds
- `GET /api/v1/articles/{articleId}/translations/{locale}/attachments` (api-v1-articles-by-articleid-translations-by-locale-attachments, read-only) — params: params, query
- `GET /api/v1/articles/{articleId}/translations/{locale}/attachments/{attachmentId}/content` (api-v1-articles-by-articleid-translations-by-locale-attachments-by-attachmentid-content, read-only) — params: params, query
- `POST /api/v1/articles/{articleId}/translations/{locale}/attachments` (api-v1-articles-by-articleid-translations-by-locale-attachments-post) — params: file
- `POST /api/v1/articles/{articleId}/translations/{locale}/clone` (api-v1-articles-by-articleid-translations-by-locale-clone-post) — params: authorId, version, categoryId
- `GET /api/v1/articles/{articleId}/translations/{locale}/comments` (api-v1-articles-by-articleid-translations-by-locale-comments, read-only) — params: params, query
- `GET /api/v1/articles/{articleId}/translations/{locale}/comments/{commentId}` (api-v1-articles-by-articleid-translations-by-locale-comments-by-commentid, read-only) — params: params, query
- `POST /api/v1/articles/{articleId}/translations/{locale}/comments/{commentId}/convertAsTicket` (api-v1-articles-by-articleid-translations-by-locale-comments-by-commentid-convertasticket-post) — params: params, query
- `DELETE /api/v1/articles/{articleId}/translations/{locale}/comments/{commentId}` (api-v1-articles-by-articleid-translations-by-locale-comments-by-commentid-delete) — params: params, query
- `PATCH /api/v1/articles/{articleId}/translations/{locale}/comments/{commentId}` (api-v1-articles-by-articleid-translations-by-locale-comments-by-commentid-patch) — params: isPublic, attachmentIds, contentType, content
- `POST /api/v1/articles/{articleId}/translations/{locale}/comments` (api-v1-articles-by-articleid-translations-by-locale-comments-post) — params: isPublic, attachmentIds, contentType, content
- `POST /api/v1/articles/{articleId}/translations/{locale}/dissociateAttachments` (api-v1-articles-by-articleid-translations-by-locale-dissociateattachments-post) — params: attachmentIds
- `GET /api/v1/articles/{articleId}/translations/{locale}/externalImages` (api-v1-articles-by-articleid-translations-by-locale-externalimages, read-only) — params: params, query
- `GET /api/v1/articles/{articleId}/translations/{locale}/feedbacks` (api-v1-articles-by-articleid-translations-by-locale-feedbacks, read-only) — params: params, query
- `POST /api/v1/articles/{articleId}/translations/{locale}/feedbacks` (api-v1-articles-by-articleid-translations-by-locale-feedbacks-post) — params: content
- `GET /api/v1/articles/{articleId}/translations/{locale}/interactedUsers` (api-v1-articles-by-articleid-translations-by-locale-interactedusers, read-only) — params: params, query
- `GET /api/v1/articles/{articleId}/translations/{locale}/interactedUsers/count` (api-v1-articles-by-articleid-translations-by-locale-interactedusers-count, read-only) — params: params, query
- `POST /api/v1/articles/{articleId}/translations/{locale}/moveToTrash` (api-v1-articles-by-articleid-translations-by-locale-movetotrash-post) — params: params, query
- `PATCH /api/v1/articles/{articleId}/translations/{locale}` (api-v1-articles-by-articleid-translations-by-locale-patch) — params: seoDescription, permission, title, seoTitle, seoKeywords, authorId, translationState, tags, expiryDate, isSEOEnabled, answer, attachmentIds, permalink, secondaryTitles, status, translationSource
- `POST /api/v1/articles/{articleId}/translations/{locale}/uploadExternalImagesToGallery` (api-v1-articles-by-articleid-translations-by-locale-uploadexternalimagestogallery-post) — params: ignoreClassName, version
- `POST /api/v1/articles/{articleId}/translations` (api-v1-articles-by-articleid-translations-post) — params: seoDescription, permission, title, seoTitle, seoKeywords, locale, authorId, translationState, tags, expiryDate, isSEOEnabled, answer, attachmentIds, permalink, status, translationSource
- `GET /api/v1/articles/{articleId}/trends` (api-v1-articles-by-articleid-trends, read-only) — params: params, query
- `GET /api/v1/articles/{id}` (api-v1-articles-by-id, read-only) — params: params, query
- `PATCH /api/v1/articles/{id}` (api-v1-articles-by-id-patch) — params: seoDescription, permission, title, authorId, seoTitle, seoKeywords, tags, expiryDate, isSEOEnabled, answer, permalink, categoryId, status, departmentId, secondaryTitles, ownerId
- `GET /api/v1/articles/{id}/translations/{locale}` (api-v1-articles-by-id-translations-by-locale, read-only) — params: params, query
- `GET /api/v1/articles/{id}/translations/{locale}/answer` (api-v1-articles-by-id-translations-by-locale-answer, read-only) — params: params, query
- `GET /api/v1/articles/{id}/translations/{locale}/concurrentEditStatus` (api-v1-articles-by-id-translations-by-locale-concurrenteditstatus, read-only) — params: params, query
- `POST /api/v1/articles/{id}/translations/{locale}/dislike` (api-v1-articles-by-id-translations-by-locale-dislike-post) — params: params, query
- `GET /api/v1/articles/{id}/translations/{locale}/insights` (api-v1-articles-by-id-translations-by-locale-insights, read-only) — params: params, query
- `POST /api/v1/articles/{id}/translations/{locale}/like` (api-v1-articles-by-id-translations-by-locale-like-post) — params: params, query
- `GET /api/v1/articles/{id}/translations/{locale}/permalinks` (api-v1-articles-by-id-translations-by-locale-permalinks, read-only) — params: params, query
- `POST /api/v1/articles/{id}/translations/{locale}/permalinks/add` (api-v1-articles-by-id-translations-by-locale-permalinks-add-post) — params: isOldPermalinkNeeded, permalink
- `POST /api/v1/articles/{id}/translations/{locale}/permalinks` (api-v1-articles-by-id-translations-by-locale-permalinks-post) — params: primaryPermalink, secondaryPermalinks
- `GET /api/v1/articles/{id}/translations/{locale}/versionDiff` (api-v1-articles-by-id-translations-by-locale-versiondiff, read-only) — params: params, query
- `GET /api/v1/articles/{id}/translations/{locale}/versions` (api-v1-articles-by-id-translations-by-locale-versions, read-only) — params: params, query
- `POST /api/v1/articles/checkPermalinkAvailability` (api-v1-articles-checkpermalinkavailability-post) — params: permalink, locale, articleId
- `GET /api/v1/articles/count` (api-v1-articles-count, read-only) — params: query
- `GET /api/v1/articles/docsResourcesInfo` (api-v1-articles-docsresourcesinfo, read-only) — params: query
- `POST /api/v1/articles/moveToTrash` (api-v1-articles-movetotrash-post) — params: ids
- `POST /api/v1/articles` (api-v1-articles-post) — params: seoDescription, permission, title, authorId, seoTitle, seoKeywords, tags, expiryDate, isSEOEnabled, isTemplate, answer, attachmentIds, permalink, categoryId, status, departmentId, ownerId
- `POST /api/v1/articles/preview` (api-v1-articles-preview-post) — params: answer, title
- `POST /api/v1/articles/scheduleAutoTranslate` (api-v1-articles-scheduleautotranslate-post) — params: ids, locales
- `GET /api/v1/articles/search` (api-v1-articles-search, read-only) — params: query
- `POST /api/v1/articles/shareDocsWorkspace` (api-v1-articles-sharedocsworkspace-post) — params: seoDescription, permission, title, authorId, seoTitle, seoKeywords, tags, expiryDate, isSEOEnabled, isTemplate, answer, attachmentIds, permalink, categoryId, status, departmentId, ownerId
- `POST /api/v1/articles/stopAutoTranslate` (api-v1-articles-stopautotranslate-post) — params: ids, locales
- `GET /api/v1/articles/trends` (api-v1-articles-trends, read-only) — params: query
- `POST /api/v1/articles/uploadExternalImagesToGallery` (api-v1-articles-uploadexternalimagestogallery-post) — params: ignoreClassName, content, workspaceId
- `GET /api/v1/articleTags` (api-v1-articletags, read-only) — params: query
- `GET /api/v1/articleTranslations` (api-v1-articletranslations, read-only) — params: query
- `GET /api/v1/articleTranslations/{id}` (api-v1-articletranslations-by-id, read-only) — params: params, query
- `GET /api/v1/articleTranslations/count` (api-v1-articletranslations-count, read-only) — params: query
- `GET /api/v1/articleTranslations/search` (api-v1-articletranslations-search, read-only) — params: query
- `GET /api/v1/articleTranslations/searchByTag` (api-v1-articletranslations-searchbytag, read-only) — params: query
- `GET /api/v1/articleTranslations/trashedTranslations` (api-v1-articletranslations-trashedtranslations, read-only) — params: query
- `GET /api/v1/articleTranslations/trashedTranslations/count` (api-v1-articletranslations-trashedtranslations-count, read-only) — params: query
- `POST /api/v1/articleTranslations/trashedTranslations/delete` (api-v1-articletranslations-trashedtranslations-delete-post) — params: ids
- `POST /api/v1/articleTranslations/trashedTranslations/restore` (api-v1-articletranslations-trashedtranslations-restore-post) — params: ids
- `GET /api/v1/associatedTickets` (api-v1-associatedtickets, read-only) — params: query
- `GET /api/v1/automationFeatureCount` (api-v1-automationfeaturecount, read-only) — params: query
- `GET /api/v1/availableDependencyMappings` (api-v1-availabledependencymappings, read-only) — params: query
- `GET /api/v1/badges` (api-v1-badges, read-only) — params: query
- `PATCH /api/v1/blueprintDrafts/{draftblueprint_id}` (api-v1-blueprintdrafts-by-draftblueprint-id-patch) — params: criteria, departmentId, module, description, dynamicTransOwnerType, type, transitions, layoutId, states, chartData, strictModeConfig, name, connections, fieldId
- `POST /api/v1/blueprintDrafts/{draftblueprint_id}/publish` (api-v1-blueprintdrafts-by-draftblueprint-id-publish-post) — params: params, query
- `POST /api/v1/blueprintDrafts` (api-v1-blueprintdrafts-post) — params: criteria, departmentId, module, description, dynamicTransOwnerType, type, transitions, layoutId, states, chartData, strictModeConfig, name, connections, fieldId
- `GET /api/v1/blueprints` (api-v1-blueprints, read-only) — params: query
- `GET /api/v1/blueprints/{blueprint_id}` (api-v1-blueprints-by-blueprint-id, read-only) — params: params, query
- `GET /api/v1/blueprints/{blueprint_id}/checkIfAppliedForEntity` (api-v1-blueprints-by-blueprint-id-checkifappliedforentity, read-only) — params: params, query
- `DELETE /api/v1/blueprints/{blueprint_id}` (api-v1-blueprints-by-blueprint-id-delete) — params: params, query
- `PATCH /api/v1/blueprints/{blueprint_id}` (api-v1-blueprints-by-blueprint-id-patch) — params: criteria, departmentId, module, description, dynamicTransOwnerType, type, transitions, layoutId, states, chartData, strictModeConfig, name, connections, fieldId, active
- `POST /api/v1/blueprints/{blueprint_id}/revoke` (api-v1-blueprints-by-blueprint-id-revoke-post) — params: params, query
- `GET /api/v1/blueprints/criteriaFields` (api-v1-blueprints-criteriafields, read-only) — params: query
- `GET /api/v1/blueprints/fieldsToConfigure` (api-v1-blueprints-fieldstoconfigure, read-only) — params: query
- `POST /api/v1/blueprints` (api-v1-blueprints-post) — params: criteria, departmentId, module, description, dynamicTransOwnerType, type, transitions, layoutId, states, chartData, strictModeConfig, name, connections, fieldId, active
- `POST /api/v1/blueprints/reorder` (api-v1-blueprints-reorder-post) — params: ids
- `POST /api/v1/blueprints/revokeMany` (api-v1-blueprints-revokemany-post) — params: ids
- `GET /api/v1/bug/{bugId}/tickets` (api-v1-bug-by-bugid-tickets, read-only) — params: params, query
- `GET /api/v1/bulkExport/{exportId}` (api-v1-bulkexport-by-exportid, read-only) — params: params, query
- `POST /api/v1/bulkExport` (api-v1-bulkexport-post) — params: modifiedAfter, exportTimeFilter, callBackUrl, password, apiNameAsHeader, criteria, module, fields, limitPerFile, exportId, viewId, departmentId
- `GET /api/v1/businessHours` (api-v1-businesshours, read-only) — params: query
- `GET /api/v1/businessHours/{businessHourId}` (api-v1-businesshours-by-businesshourid, read-only) — params: params, query
- `DELETE /api/v1/businessHours/{businessHourId}` (api-v1-businesshours-by-businesshourid-delete) — params: params, query
- `PATCH /api/v1/businessHours/{businessHourId}` (api-v1-businesshours-by-businesshourid-patch) — params: timeZoneId, name, holidayListId, businessTimes, type, status, holidayListIds
- `GET /api/v1/businessHours/{businessHourId}/relatedRules` (api-v1-businesshours-by-businesshourid-relatedrules, read-only) — params: params, query
- `POST /api/v1/businessHours` (api-v1-businesshours-post) — params: timeZoneId, name, holidayListId, holidayListIds, businessTimes, type, status
- `GET /api/v1/{moduleApiName}` (api-v1-by-moduleapiname, read-only) — params: params, query
- `POST /api/v1/{moduleAPIName}/{entityId}/follow` (api-v1-by-moduleapiname-by-entityid-follow-post) — params: params, query
- `GET /api/v1/{moduleAPIName}/{entityId}/followers` (api-v1-by-moduleapiname-by-entityid-followers, read-only) — params: params, query
- `GET /api/v1/{moduleAPIName}/{entityId}/followersCount` (api-v1-by-moduleapiname-by-entityid-followerscount, read-only) — params: params, query
- `POST /api/v1/{moduleAPIName}/{entityId}/unfollow` (api-v1-by-moduleapiname-by-entityid-unfollow-post) — params: params, query
- `GET /api/v1/{moduleApiName}/{recordId}` (api-v1-by-moduleapiname-by-recordid, read-only) — params: params, query
- `DELETE /api/v1/{moduleApiName}/{recordId}` (api-v1-by-moduleapiname-by-recordid-delete) — params: params, query
- `PATCH /api/v1/{moduleApiName}/{recordId}` (api-v1-by-moduleapiname-by-recordid-patch) — params: name, layout, owner, cf, department
- `GET /api/v1/{moduleApiName}/count` (api-v1-by-moduleapiname-count, read-only) — params: params, query
- `POST /api/v1/{moduleApiName}/moveToTrash` (api-v1-by-moduleapiname-movetotrash-post) — params: recordIds
- `POST /api/v1/{moduleApiName}` (api-v1-by-moduleapiname-post) — params: name, layout, owner, cf, department
- `GET /api/v1/{moduleApiName}/search` (api-v1-by-moduleapiname-search, read-only) — params: params, query
- `POST /api/v1/{moduleApiName}/updateMany` (api-v1-by-moduleapiname-updatemany-post) — params: fieldName, ids, fieldValue
- `GET /api/v1/calls` (api-v1-calls, read-only) — params: query
- `GET /api/v1/calls/{callId}` (api-v1-calls-by-callid, read-only) — params: params, query
- `DELETE /api/v1/calls/{callId}/attachments/{attachmentId}` (api-v1-calls-by-callid-attachments-by-attachmentid-delete) — params: params, query
- `POST /api/v1/calls/{callId}/attachments` (api-v1-calls-by-callid-attachments-post) — params: file
- `POST /api/v1/calls/{callId}/clearLiveCall` (api-v1-calls-by-callid-clearlivecall-post) — params: params, query
- `GET /api/v1/calls/{callId}/comments/{commentId}` (api-v1-calls-by-callid-comments-by-commentid, read-only) — params: params, query
- `DELETE /api/v1/calls/{callId}/comments/{commentId}` (api-v1-calls-by-callid-comments-by-commentid-delete) — params: params, query
- `PATCH /api/v1/calls/{callId}/comments/{commentId}` (api-v1-calls-by-callid-comments-by-commentid-patch) — params: contentType, content, attachmentIds
- `PUT /api/v1/calls/{callId}/comments/{commentId}` (api-v1-calls-by-callid-comments-by-commentid-put) — params: contentType, content, attachmentIds
- `POST /api/v1/calls/{callId}/comments` (api-v1-calls-by-callid-comments-post) — params: contentType, content, attachmentIds
- `PATCH /api/v1/calls/{callId}` (api-v1-calls-by-callid-patch) — params: contactId, subject, departmentId, startTime, ownerId, priority, ticketId, status, duration, layoutId, cf, reminder, customFields, direction, description, teamId, recordingUrl
- `GET /api/v1/calls/{entityId}/comments` (api-v1-calls-by-entityid-comments, read-only) — params: params, query
- `POST /api/v1/calls/deleteSpam` (api-v1-calls-deletespam-post) — params: callIds
- `POST /api/v1/calls/emptySpam` (api-v1-calls-emptyspam-post) — params: departmentId
- `POST /api/v1/calls/moveToTrash` (api-v1-calls-movetotrash-post) — params: entityIds
- `POST /api/v1/calls` (api-v1-calls-post) — params: contactId, subject, departmentId, startTime, ownerId, priority, ticketId, status, duration, cf, reminder, customFields, layoutId, direction, description, teamId, recordingUrl
- `GET /api/v1/calls/search` (api-v1-calls-search, read-only) — params: query
- `POST /api/v1/calls/updateMany` (api-v1-calls-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `GET /api/v1/channels` (api-v1-channels, read-only) — params: query
- `GET /api/v1/channels/{channelCode}` (api-v1-channels-by-channelcode, read-only) — params: params, query
- `GET /api/v1/channels/{channelCode}/photo` (api-v1-channels-by-channelcode-photo, read-only) — params: params, query
- `POST /api/v1/channels/{channelCode}/photo` (api-v1-channels-by-channelcode-photo-post) — params: photo
- `POST /api/v1/closeTickets` (api-v1-closetickets-post) — params: ids
- `POST /api/v1/community/markAllCommentsAsSpam` (api-v1-community-markallcommentsasspam-post) — params: reason, commentIds
- `POST /api/v1/community/markAllTopicsAsSpam` (api-v1-community-markalltopicsasspam-post) — params: reason, topicIds
- `GET /api/v1/communityAttachments/{id}/content` (api-v1-communityattachments-by-id-content, read-only) — params: params, query
- `POST /api/v1/communityAttachments` (api-v1-communityattachments-post) — params: file
- `GET /api/v1/communityCategory` (api-v1-communitycategory, read-only) — params: query
- `GET /api/v1/communityCategory/{categoryId}` (api-v1-communitycategory-by-categoryid, read-only) — params: params, query
- `POST /api/v1/communityCategory/{categoryId}/disable` (api-v1-communitycategory-by-categoryid-disable-post) — params: params, query
- `POST /api/v1/communityCategory/{categoryId}/enable` (api-v1-communitycategory-by-categoryid-enable-post) — params: params, query
- `POST /api/v1/communityCategory/{categoryId}/follow` (api-v1-communitycategory-by-categoryid-follow-post) — params: params, query
- `GET /api/v1/communityCategory/{categoryId}/followers` (api-v1-communitycategory-by-categoryid-followers, read-only) — params: params, query
- `POST /api/v1/communityCategory/{categoryId}/lock` (api-v1-communitycategory-by-categoryid-lock-post) — params: params, query
- `POST /api/v1/communityCategory/{categoryId}/unfollow` (api-v1-communitycategory-by-categoryid-unfollow-post) — params: params, query
- `GET /api/v1/communityCategoryByPermalink` (api-v1-communitycategorybypermalink, read-only) — params: query
- `POST /api/v1/communityCategoryLogo` (api-v1-communitycategorylogo-post) — params: file
- `POST /api/v1/communityComments/approve` (api-v1-communitycomments-approve-post) — params: commentIds
- `GET /api/v1/communityComments/count` (api-v1-communitycomments-count, read-only) — params: query
- `DELETE /api/v1/communityComments` (api-v1-communitycomments-delete) — params: commentIds
- `POST /api/v1/communityComments/moveToTrash` (api-v1-communitycomments-movetotrash-post) — params: commentIds
- `POST /api/v1/communityComments/restore` (api-v1-communitycomments-restore-post) — params: commentIds
- `GET /api/v1/communityModeratedTopics` (api-v1-communitymoderatedtopics, read-only) — params: query
- `GET /api/v1/communityModeratedUsers` (api-v1-communitymoderatedusers, read-only) — params: query
- `GET /api/v1/communityModeration/comments` (api-v1-communitymoderation-comments, read-only) — params: query
- `GET /api/v1/communityModeration/counts` (api-v1-communitymoderation-counts, read-only) — params: query
- `GET /api/v1/communityModeration/topics` (api-v1-communitymoderation-topics, read-only) — params: query
- `GET /api/v1/communityMyDraftedTopics` (api-v1-communitymydraftedtopics, read-only) — params: query
- `GET /api/v1/communityPreferences` (api-v1-communitypreferences, read-only) — params: query
- `POST /api/v1/communityPreferences` (api-v1-communitypreferences-post) — params: landingPage
- `GET /api/v1/communityTopicByPermalink` (api-v1-communitytopicbypermalink, read-only) — params: query
- `GET /api/v1/communityTopics` (api-v1-communitytopics, read-only) — params: query
- `POST /api/v1/communityTopics/addAsTicket` (api-v1-communitytopics-addasticket-post) — params: topicIds
- `POST /api/v1/communityTopics/approve` (api-v1-communitytopics-approve-post) — params: topicIds
- `GET /api/v1/communityTopics/{topicId}` (api-v1-communitytopics-by-topicid, read-only) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/addAsTicket` (api-v1-communitytopics-by-topicid-addasticket-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/associateTags` (api-v1-communitytopics-by-topicid-associatetags-post) — params: tags
- `GET /api/v1/communityTopics/{topicId}/attachments/{attachmentId}/content` (api-v1-communitytopics-by-topicid-attachments-by-attachmentid-content, read-only) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/comments` (api-v1-communitytopics-by-topicid-comments, read-only) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/comments/{commentId}` (api-v1-communitytopics-by-topicid-comments-by-commentid, read-only) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/comments/{commentId}/attachments/{attachmentId}/content` (api-v1-communitytopics-by-topicid-comments-by-commentid-attachments-by-attachmentid-content, read-only) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/comments/{commentId}/markSpam` (api-v1-communitytopics-by-topicid-comments-by-commentid-markspam-post) — params: reason
- `POST /api/v1/communityTopics/{topicId}/comments/{commentId}/moveToTrash` (api-v1-communitytopics-by-topicid-comments-by-commentid-movetotrash-post) — params: params, query
- `PATCH /api/v1/communityTopics/{topicId}/comments/{commentId}` (api-v1-communitytopics-by-topicid-comments-by-commentid-patch) — params: attachmentIds, content, notifyMentions, isBestComment
- `POST /api/v1/communityTopics/{topicId}/comments/{commentId}/replies/{replyId}/moveToTrash` (api-v1-communitytopics-by-topicid-comments-by-commentid-replies-by-replyid-movetotrash-post) — params: params, query
- `PATCH /api/v1/communityTopics/{topicId}/comments/{commentId}/replies/{replyId}` (api-v1-communitytopics-by-topicid-comments-by-commentid-replies-by-replyid-patch) — params: attachmentIds, content, notifyMentions, isBestComment
- `POST /api/v1/communityTopics/{topicId}/comments/{parentCommentId}/replies` (api-v1-communitytopics-by-topicid-comments-by-parentcommentid-replies-post) — params: attachmentIds, content
- `POST /api/v1/communityTopics/{topicId}/comments` (api-v1-communitytopics-by-topicid-comments-post) — params: attachmentIds, content
- `DELETE /api/v1/communityTopics/{topicId}/deleteDraft` (api-v1-communitytopics-by-topicid-deletedraft-delete) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/dissociateTags` (api-v1-communitytopics-by-topicid-dissociatetags-post) — params: tags
- `POST /api/v1/communityTopics/{topicId}/follow` (api-v1-communitytopics-by-topicid-follow-post) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/followers` (api-v1-communitytopics-by-topicid-followers, read-only) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/like` (api-v1-communitytopics-by-topicid-like-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/lock` (api-v1-communitytopics-by-topicid-lock-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/markSpam` (api-v1-communitytopics-by-topicid-markspam-post) — params: reason
- `POST /api/v1/communityTopics/{topicId}/moderate` (api-v1-communitytopics-by-topicid-moderate-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/move` (api-v1-communitytopics-by-topicid-move-post) — params: categoryId
- `POST /api/v1/communityTopics/{topicId}/moveToTrash` (api-v1-communitytopics-by-topicid-movetotrash-post) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/participants` (api-v1-communitytopics-by-topicid-participants, read-only) — params: params, query
- `PATCH /api/v1/communityTopics/{topicId}` (api-v1-communitytopics-by-topicid-patch) — params: featuredImage, subject, attachmentIds, label, type, seo, content, notifyMentions, isSticky, categoryId, tags, notifyMe
- `GET /api/v1/communityTopics/{topicId}/permalinks` (api-v1-communitytopics-by-topicid-permalinks, read-only) — params: params, query
- `PATCH /api/v1/communityTopics/{topicId}/permalinks` (api-v1-communitytopics-by-topicid-permalinks-patch) — params: primaryPermalink, secondaryPermalink
- `POST /api/v1/communityTopics/{topicId}/publishDraft` (api-v1-communitytopics-by-topicid-publishdraft-post) — params: featuredImage, subject, attachmentIds, type, seo, content, mailTo, permalink, isSticky, categoryId, notifyMe, tags
- `GET /api/v1/communityTopics/{topicId}/replies/{replyId}/attachments/{attachmentId}/content` (api-v1-communitytopics-by-topicid-replies-by-replyid-attachments-by-attachmentid-content, read-only) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/ticket` (api-v1-communitytopics-by-topicid-ticket, read-only) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/unfollow` (api-v1-communitytopics-by-topicid-unfollow-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/unlike` (api-v1-communitytopics-by-topicid-unlike-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/unlock` (api-v1-communitytopics-by-topicid-unlock-post) — params: params, query
- `POST /api/v1/communityTopics/{topicId}/unmoderate` (api-v1-communitytopics-by-topicid-unmoderate-post) — params: params, query
- `PUT /api/v1/communityTopics/{topicId}/updateDraft` (api-v1-communitytopics-by-topicid-updatedraft-put) — params: featuredImage, subject, attachmentIds, type, seo, content, permalink, isSticky, categoryId, notifyMe, tags
- `GET /api/v1/communityTopics/{topicId}/voters` (api-v1-communitytopics-by-topicid-voters, read-only) — params: params, query
- `GET /api/v1/communityTopics/{topicId}/voters/trend` (api-v1-communitytopics-by-topicid-voters-trend, read-only) — params: params, query
- `GET /api/v1/communityTopics/count` (api-v1-communitytopics-count, read-only) — params: query
- `DELETE /api/v1/communityTopics` (api-v1-communitytopics-delete) — params: topicIds
- `POST /api/v1/communityTopics/moveToTrash` (api-v1-communitytopics-movetotrash-post) — params: topicIds
- `GET /api/v1/communityTopics/permalink/availability` (api-v1-communitytopics-permalink-availability, read-only) — params: query
- `POST /api/v1/communityTopics` (api-v1-communitytopics-post) — params: featuredImage, subject, attachmentIds, type, seo, content, mailTo, permalink, isSticky, categoryId, notifyMe, tags
- `POST /api/v1/communityTopics/restore` (api-v1-communitytopics-restore-post) — params: topicIds
- `POST /api/v1/communityTopics/saveDraft` (api-v1-communitytopics-savedraft-post) — params: featuredImage, subject, attachmentIds, type, seo, content, permalink, isSticky, categoryId, notifyMe, tags
- `GET /api/v1/communityTopics/search` (api-v1-communitytopics-search, read-only) — params: query
- `POST /api/v1/communityTopics/unmoderate` (api-v1-communitytopics-unmoderate-post) — params: topicIds
- `POST /api/v1/communityTopics/updateMany` (api-v1-communitytopics-updatemany-post) — params: fieldName, ids, fieldValue
- `GET /api/v1/communityTopicTypes` (api-v1-communitytopictypes, read-only) — params: query
- `PATCH /api/v1/communityTopicTypes` (api-v1-communitytopictypes-patch) — params: defaultTopicType, enabledTopicTypes
- `GET /api/v1/communityUsers/{userId}` (api-v1-communityusers-by-userid, read-only) — params: params, query
- `GET /api/v1/communityUsers/{userId}/comments` (api-v1-communityusers-by-userid-comments, read-only) — params: params, query
- `POST /api/v1/communityUsers/{userId}/follow` (api-v1-communityusers-by-userid-follow-post) — params: params, query
- `GET /api/v1/communityUsers/{userId}/followers` (api-v1-communityusers-by-userid-followers, read-only) — params: params, query
- `PATCH /api/v1/communityUsers/{userId}` (api-v1-communityusers-by-userid-patch) — params: isModerated
- `GET /api/v1/communityUsers/{userId}/topics` (api-v1-communityusers-by-userid-topics, read-only) — params: params, query
- `POST /api/v1/communityUsers/{userId}/unfollow` (api-v1-communityusers-by-userid-unfollow-post) — params: params, query
- `POST /api/v1/communityUsers/unmoderate` (api-v1-communityusers-unmoderate-post) — params: userIds
- `GET /api/v1/contacts` (api-v1-contacts, read-only) — params: query, body
- `GET /api/v1/contacts/{contactId}` (api-v1-contacts-by-contactid, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/accounts` (api-v1-contacts-by-contactid-accounts, read-only) — params: params, query
- `PATCH /api/v1/contacts/{contactId}/accounts/{accountId}/dissociate` (api-v1-contacts-by-contactid-accounts-by-accountid-dissociate-patch) — params: option, optionValue
- `POST /api/v1/contacts/{contactId}/addFollowers` (api-v1-contacts-by-contactid-addfollowers-post) — params: followerIds
- `POST /api/v1/contacts/{contactId}/approveEndUserInvite` (api-v1-contacts-by-contactid-approveenduserinvite-post) — params: helpCenterIds
- `POST /api/v1/contacts/{contactId}/associateAccounts` (api-v1-contacts-by-contactid-associateaccounts-post) — params: data, ids
- `POST /api/v1/contacts/{contactId}/associateProducts` (api-v1-contacts-by-contactid-associateproducts-post) — params: departmentId, ids, associate
- `GET /api/v1/contacts/{contactId}/attachments` (api-v1-contacts-by-contactid-attachments, read-only) — params: params, query
- `DELETE /api/v1/contacts/{contactId}/attachments/{attachmentId}` (api-v1-contacts-by-contactid-attachments-by-attachmentid-delete) — params: params, query
- `POST /api/v1/contacts/{contactId}/attachments` (api-v1-contacts-by-contactid-attachments-post) — params: file
- `GET /api/v1/contacts/{contactId}/comments` (api-v1-contacts-by-contactid-comments, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/comments/{commentId}` (api-v1-contacts-by-contactid-comments-by-commentid, read-only) — params: params, query
- `DELETE /api/v1/contacts/{contactId}/comments/{commentId}` (api-v1-contacts-by-contactid-comments-by-commentid-delete) — params: params, query
- `PUT /api/v1/contacts/{contactId}/comments/{commentId}` (api-v1-contacts-by-contactid-comments-by-commentid-put) — params: content, contentType
- `POST /api/v1/contacts/{contactId}/comments` (api-v1-contacts-by-contactid-comments-post) — params: contentType, content
- `POST /api/v1/contacts/{contactId}/dissociateAccounts` (api-v1-contacts-by-contactid-dissociateaccounts-post) — params: ids
- `GET /api/v1/contacts/{contactId}/followers` (api-v1-contacts-by-contactid-followers, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/helpCenters` (api-v1-contacts-by-contactid-helpcenters, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/history` (api-v1-contacts-by-contactid-history, read-only) — params: params, query
- `POST /api/v1/contacts/{contactId}/inviteAsEndUser` (api-v1-contacts-by-contactid-inviteasenduser-post) — params: helpCenterId
- `POST /api/v1/contacts/{contactId}/merge` (api-v1-contacts-by-contactid-merge-post) — params: ids, source
- `PATCH /api/v1/contacts/{contactId}` (api-v1-contacts-by-contactid-patch) — params: lastName, accountId, firstName, secondaryEmail, phone, mobile, ownerId, type, email, zip, country, twitter, cf, city, customFields, street, facebook, description, state, title, layoutId, language
- `DELETE /api/v1/contacts/{contactId}/photo` (api-v1-contacts-by-contactid-photo-delete) — params: params, query
- `GET /api/v1/contacts/{contactId}/products` (api-v1-contacts-by-contactid-products, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/profiles` (api-v1-contacts-by-contactid-profiles, read-only) — params: params, query
- `POST /api/v1/contacts/{contactId}/rejectEndUserInvite` (api-v1-contacts-by-contactid-rejectenduserinvite-post) — params: helpCenterIds
- `POST /api/v1/contacts/{contactId}/removeFollowers` (api-v1-contacts-by-contactid-removefollowers-post) — params: followerIds
- `GET /api/v1/contacts/{contactId}/statistics` (api-v1-contacts-by-contactid-statistics, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/tickets` (api-v1-contacts-by-contactid-tickets, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/timeEntry` (api-v1-contacts-by-contactid-timeentry, read-only) — params: params, query
- `GET /api/v1/contacts/{contactId}/timeEntrySummation` (api-v1-contacts-by-contactid-timeentrysummation, read-only) — params: params, query
- `GET /api/v1/contacts/contactsByIds` (api-v1-contacts-contactsbyids, read-only) — params: query
- `GET /api/v1/contacts/count` (api-v1-contacts-count, read-only) — params: query
- `POST /api/v1/contacts/deleteSpam` (api-v1-contacts-deletespam-post) — params: contactIds
- `POST /api/v1/contacts/inviteAsEndUser` (api-v1-contacts-inviteasenduser-post) — params: helpCenterId, contactIds
- `POST /api/v1/contacts/markSpam` (api-v1-contacts-markspam-post) — params: ids, isSpam, handleExistingTickets
- `POST /api/v1/contacts/moveToTrash` (api-v1-contacts-movetotrash-post) — params: contactIds
- `POST /api/v1/contacts` (api-v1-contacts-post) — params: lastName, accountId, firstName, secondaryEmail, phone, mobile, ownerId, type, email, zip, country, twitter, cf, city, customFields, street, facebook, description, state, title, layoutId, language
- `GET /api/v1/contacts/search` (api-v1-contacts-search, read-only) — params: query
- `POST /api/v1/contacts/updateMany` (api-v1-contacts-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `GET /api/v1/contactsDeduplication/defaultFieldName` (api-v1-contactsdeduplication-defaultfieldname, read-only) — params: query
- `POST /api/v1/contactsDeduplication/defaultFieldName` (api-v1-contactsdeduplication-defaultfieldname-post) — params: fieldName, markDefault
- `GET /api/v1/contracts` (api-v1-contracts, read-only) — params: query
- `GET /api/v1/contracts/{contractId}/comments` (api-v1-contracts-by-contractid-comments, read-only) — params: params, query
- `GET /api/v1/contracts/{contractId}/comments/{commentId}` (api-v1-contracts-by-contractid-comments-by-commentid, read-only) — params: params, query
- `GET /api/v1/contracts/{contractId}/comments/{commentId}/attachments/{attachmentId}/content` (api-v1-contracts-by-contractid-comments-by-commentid-attachments-by-attachmentid-content, read-only) — params: params, query
- `DELETE /api/v1/contracts/{contractId}/comments/{commentId}` (api-v1-contracts-by-contractid-comments-by-commentid-delete) — params: params, query
- `PATCH /api/v1/contracts/{contractId}/comments/{commentId}` (api-v1-contracts-by-contractid-comments-by-commentid-patch) — params: contentType, content
- `PUT /api/v1/contracts/{contractId}/comments/{commentId}` (api-v1-contracts-by-contractid-comments-by-commentid-put) — params: contentType, content
- `POST /api/v1/contracts/{contractId}/comments` (api-v1-contracts-by-contractid-comments-post) — params: contentType, content, attachmentIds
- `GET /api/v1/contracts/{id}` (api-v1-contracts-by-id, read-only) — params: params, query
- `PATCH /api/v1/contracts/{id}` (api-v1-contracts-by-id-patch) — params: associatedSLAId, cf, productId, endDate, customFields, departmentId, notifyBefore, contractNumber, description, ownerId, notificationAgentIds, accountId, contractName, startDate, layoutId
- `PUT /api/v1/contracts/{id}` (api-v1-contracts-by-id-put) — params: associatedSLAId, cf, productId, endDate, customFields, departmentId, notifyBefore, contractNumber, description, ownerId, notificationAgentIds, accountId, contractName, startDate, layoutId
- `GET /api/v1/contracts/count` (api-v1-contracts-count, read-only) — params: query
- `POST /api/v1/contracts` (api-v1-contracts-post) — params: associatedSLAId, cf, productId, endDate, customFields, departmentId, notifyBefore, contractNumber, description, associatedSupportPlanId, ownerId, notificationAgentIds, accountId, contractName, startDate, layoutId, sla, account, product
- `POST /api/v1/contracts/updateMany` (api-v1-contracts-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `POST /api/v1/convertCloudDocumentToHtml` (api-v1-convertclouddocumenttohtml-post) — params: accountId, filePath, name, source, id, type, mimeType, workspaceId
- `GET /api/v1/countries` (api-v1-countries, read-only)
- `GET /api/v1/customerHappinessLinkHolder` (api-v1-customerhappinesslinkholder, read-only) — params: query
- `GET /api/v1/customFieldCount` (api-v1-customfieldcount, read-only) — params: query
- `GET /api/v1/dashboards/backlogTickets` (api-v1-dashboards-backlogtickets, read-only) — params: query
- `GET /api/v1/dashboards/createdTickets` (api-v1-dashboards-createdtickets, read-only) — params: query
- `GET /api/v1/dashboards/onholdTickets` (api-v1-dashboards-onholdtickets, read-only) — params: query
- `GET /api/v1/dashboards/reopenedTickets` (api-v1-dashboards-reopenedtickets, read-only) — params: query
- `GET /api/v1/dashboards/responseCount` (api-v1-dashboards-responsecount, read-only) — params: query
- `GET /api/v1/dashboards/responseTime` (api-v1-dashboards-responsetime, read-only) — params: query
- `GET /api/v1/dashboards/solvedTickets` (api-v1-dashboards-solvedtickets, read-only) — params: query
- `GET /api/v1/dashboards/ticketsResolutionTime` (api-v1-dashboards-ticketsresolutiontime, read-only) — params: query
- `GET /api/v1/dataSharingRules` (api-v1-datasharingrules, read-only) — params: query
- `PATCH /api/v1/dataSharingRules` (api-v1-datasharingrules-patch) — params: tickets, calls, accounts, contracts, contacts, tasks, events, products
- `GET /api/v1/deletedAgents` (api-v1-deletedagents, read-only) — params: query
- `POST /api/v1/deletedAgents/{agentId}/anonymize` (api-v1-deletedagents-by-agentid-anonymize-post) — params: anonymizedName
- `POST /api/v1/deleteMyPhoto` (api-v1-deletemyphoto-post) — params: query
- `GET /api/v1/departments` (api-v1-departments, read-only) — params: query
- `GET /api/v1/departments/{departmentId}` (api-v1-departments-by-departmentid, read-only) — params: params, query
- `GET /api/v1/departments/{departmentId}/agents` (api-v1-departments-by-departmentid-agents, read-only) — params: params, query
- `GET /api/v1/departments/{departmentId}/associableAgents` (api-v1-departments-by-departmentid-associableagents, read-only) — params: params, query
- `POST /api/v1/departments/{departmentId}/associateAgents` (api-v1-departments-by-departmentid-associateagents-post) — params: agentIds
- `POST /api/v1/departments/{departmentId}/disable` (api-v1-departments-by-departmentid-disable-post) — params: emailNewDepartment, agentNewDepartment
- `POST /api/v1/departments/{departmentId}/dissociateAgents` (api-v1-departments-by-departmentid-dissociateagents-post) — params: agentIds
- `POST /api/v1/departments/{departmentId}/enable` (api-v1-departments-by-departmentid-enable-post) — params: params, query
- `GET /api/v1/departments/{departmentId}/logo` (api-v1-departments-by-departmentid-logo, read-only) — params: params, query
- `DELETE /api/v1/departments/{departmentId}/logo` (api-v1-departments-by-departmentid-logo-delete) — params: params, query
- `POST /api/v1/departments/{departmentId}/logo` (api-v1-departments-by-departmentid-logo-post) — params: departmentLogo
- `GET /api/v1/departments/{departmentId}/mailConfigurations` (api-v1-departments-by-departmentid-mailconfigurations, read-only) — params: params, query
- `PATCH /api/v1/departments/{departmentId}/mailConfigurations` (api-v1-departments-by-departmentid-mailconfigurations-patch) — params: createContactWithReplyTo, autoCCToMailbox, agentNameInTicketReply, createTicketForOriginalSender, privateThreadConfig
- `PUT /api/v1/departments/{departmentId}/mailConfigurations` (api-v1-departments-by-departmentid-mailconfigurations-put) — params: createContactWithReplyTo, autoCCToMailbox, agentNameInTicketReply, createTicketForOriginalSender, privateThreadConfig
- `PATCH /api/v1/departments/{departmentId}` (api-v1-departments-by-departmentid-patch) — params: isAssignToTeamEnabled, nameInCustomerPortal, name, description, isVisibleInCustomerPortal, associatedAgentIds
- `GET /api/v1/departments/{departmentId}/teams` (api-v1-departments-by-departmentid-teams, read-only) — params: params, query
- `GET /api/v1/departments/checkExists` (api-v1-departments-checkexists, read-only) — params: query
- `GET /api/v1/departments/count` (api-v1-departments-count, read-only) — params: query
- `POST /api/v1/departments` (api-v1-departments-post) — params: isAssignToTeamEnabled, nameInCustomerPortal, isVisibleInCustomerPortal, name, description, associatedAgentIds
- `GET /api/v1/departmentsByIds` (api-v1-departmentsbyids, read-only) — params: query
- `GET /api/v1/dependencyMappings` (api-v1-dependencymappings, read-only) — params: query
- `GET /api/v1/dependencyMappings/{dependencyMappingId}` (api-v1-dependencymappings-by-dependencymappingid, read-only) — params: params, query
- `DELETE /api/v1/dependencyMappings/{dependencyMappingId}` (api-v1-dependencymappings-by-dependencymappingid-delete) — params: params, query
- `PATCH /api/v1/dependencyMappings/{dependencyMappingId}` (api-v1-dependencymappings-by-dependencymappingid-patch) — params: mappings
- `POST /api/v1/dependencyMappings` (api-v1-dependencymappings-post) — params: parentId, childId, layoutId, mappings
- `GET /api/v1/dependencyMappingsCount` (api-v1-dependencymappingscount, read-only) — params: query
- `GET /api/v1/directAssignmentRules` (api-v1-directassignmentrules, read-only) — params: query
- `GET /api/v1/directAssignmentRules/{ruleId}` (api-v1-directassignmentrules-by-ruleid, read-only) — params: params, query
- `PATCH /api/v1/directAssignmentRules/{ruleId}` (api-v1-directassignmentrules-by-ruleid-patch) — params: name, description, status, executeOptions, targets
- `PUT /api/v1/directAssignmentRules/{ruleId}` (api-v1-directassignmentrules-by-ruleid-put) — params: name, description, status, executeOptions, targets
- `GET /api/v1/directAssignmentRules/{ruleId}/targets/{targetId}` (api-v1-directassignmentrules-by-ruleid-targets-by-targetid, read-only) — params: params, query
- `PATCH /api/v1/directAssignmentRules/{ruleId}/targets/{targetId}` (api-v1-directassignmentrules-by-ruleid-targets-by-targetid-patch) — params: targetId, criteria, fromDepartmentId, toDepartmentId, agentId, teamId
- `PUT /api/v1/directAssignmentRules/{ruleId}/targets/{targetId}` (api-v1-directassignmentrules-by-ruleid-targets-by-targetid-put) — params: targetId, criteria, fromDepartmentId, toDepartmentId, agentId, teamId
- `POST /api/v1/directAssignmentRules/{ruleId}/targets` (api-v1-directassignmentrules-by-ruleid-targets-post) — params: criteria, fromDepartmentId, toDepartmentId, agentId, teamId
- `GET /api/v1/directAssignmentRules/criteriaFields` (api-v1-directassignmentrules-criteriafields, read-only) — params: query
- `GET /api/v1/directAssignmentRules/executionStatus` (api-v1-directassignmentrules-executionstatus, read-only) — params: query
- `PUT /api/v1/directAssignmentRules/executionStatus` (api-v1-directassignmentrules-executionstatus-put) — params: status
- `POST /api/v1/directAssignmentRules` (api-v1-directassignmentrules-post) — params: name, description, status, executeOptions, targets
- `POST /api/v1/directAssignmentRules/reorder` (api-v1-directassignmentrules-reorder-post) — params: ruleIds
- `GET /api/v1/displayPreferences` (api-v1-displaypreferences, read-only) — params: query
- `POST /api/v1/displayPreferences` (api-v1-displaypreferences-post) — params: sortColumn, viewName, sortOrder, departmentId, recordsPerPage, categoryId
- `GET /api/v1/domains` (api-v1-domains, read-only) — params: query
- `POST /api/v1/domains/apply` (api-v1-domains-apply-post) — params: domain
- `GET /api/v1/domains/{domain}` (api-v1-domains-by-domain, read-only) — params: params, query
- `DELETE /api/v1/domains/{domain}` (api-v1-domains-by-domain-delete) — params: params, query
- `POST /api/v1/domains` (api-v1-domains-post) — params: domain
- `POST /api/v1/domains/reset` (api-v1-domains-reset-post) — params: query
- `POST /api/v1/domains/verify` (api-v1-domains-verify-post) — params: method, domain
- `GET /api/v1/downloadBulkExportFile` (api-v1-downloadbulkexportfile, read-only) — params: query
- `GET /api/v1/emailFailureAlerts` (api-v1-emailfailurealerts, read-only) — params: query
- `PATCH /api/v1/emailFailureAlerts` (api-v1-emailfailurealerts-patch) — params: query
- `GET /api/v1/events` (api-v1-events, read-only) — params: query
- `GET /api/v1/events/{eventId}` (api-v1-events-by-eventid, read-only) — params: params, query
- `GET /api/v1/events/{eventId}/attachments` (api-v1-events-by-eventid-attachments, read-only) — params: params, query
- `GET /api/v1/events/{eventId}/attachments/{attachmentId}/content` (api-v1-events-by-eventid-attachments-by-attachmentid-content, read-only) — params: params, query
- `DELETE /api/v1/events/{eventId}/attachments/{attachmentId}` (api-v1-events-by-eventid-attachments-by-attachmentid-delete) — params: params, query
- `POST /api/v1/events/{eventId}/attachments` (api-v1-events-by-eventid-attachments-post) — params: file
- `GET /api/v1/events/{eventId}/comments` (api-v1-events-by-eventid-comments, read-only) — params: params, query
- `GET /api/v1/events/{eventId}/comments/{commentId}` (api-v1-events-by-eventid-comments-by-commentid, read-only) — params: params, query
- `PUT /api/v1/events/{eventId}/comments/{commentId}` (api-v1-events-by-eventid-comments-by-commentid-put) — params: contentType, content, attachmentIds
- `POST /api/v1/events/{eventId}/comments` (api-v1-events-by-eventid-comments-post) — params: contentType, content, attachmentIds
- `PATCH /api/v1/events/{eventId}` (api-v1-events-by-eventid-patch) — params: contactId, subject, departmentId, startTime, ownerId, priority, category, ticketId, status, layoutId, duration, cf, reminder, customFields, description, teamId
- `POST /api/v1/events/deleteSpam` (api-v1-events-deletespam-post) — params: eventIds
- `POST /api/v1/events/emptySpam` (api-v1-events-emptyspam-post) — params: departmentId
- `POST /api/v1/events/moveToTrash` (api-v1-events-movetotrash-post) — params: entityIds
- `POST /api/v1/events` (api-v1-events-post) — params: contactId, subject, departmentId, startTime, ownerId, priority, category, ticketId, status, layoutId, duration, cf, reminder, customFields, description, teamId
- `GET /api/v1/events/search` (api-v1-events-search, read-only) — params: query
- `POST /api/v1/events/updateMany` (api-v1-events-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `GET /api/v1/fields` (api-v1-fields, read-only) — params: query
- `GET /api/v1/fields/{fieldId}` (api-v1-fields-by-fieldid, read-only) — params: params, query
- `DELETE /api/v1/fields/{fieldId}` (api-v1-fields-by-fieldid-delete) — params: params, query
- `PATCH /api/v1/fields/{fieldId}` (api-v1-fields-by-fieldid-patch) — params: displayLabel, isTrackLastActivityTime, toolTip, toolTipType, type, maxLength, isEncryptedField
- `POST /api/v1/fields` (api-v1-fields-post) — params: displayLabel, isTrackLastActivityTime, toolTip, toolTipType, type, maxLength, isEncryptedField
- `GET /api/v1/finance/invoices/{id}/tickets` (api-v1-finance-invoices-by-id-tickets, read-only) — params: params, query
- `GET /api/v1/getMyFollowedEntities` (api-v1-getmyfollowedentities, read-only) — params: query
- `GET /api/v1/groupAccountDuplicateValues` (api-v1-groupaccountduplicatevalues, read-only) — params: query
- `GET /api/v1/groupAccounts` (api-v1-groupaccounts, read-only) — params: query
- `GET /api/v1/groupContactDuplicateValues` (api-v1-groupcontactduplicatevalues, read-only) — params: query
- `GET /api/v1/groupContacts` (api-v1-groupcontacts, read-only) — params: query
- `GET /api/v1/groups` (api-v1-groups, read-only) — params: query
- `GET /api/v1/groups/{groupId}` (api-v1-groups-by-groupid, read-only) — params: params, query
- `DELETE /api/v1/groups/{groupId}` (api-v1-groups-by-groupid-delete) — params: params, query
- `PATCH /api/v1/groups/{groupId}` (api-v1-groups-by-groupid-patch) — params: name, description, logoId
- `GET /api/v1/groups/{groupId}/users` (api-v1-groups-by-groupid-users, read-only) — params: params, query
- `POST /api/v1/groups/{groupId}/users/add` (api-v1-groups-by-groupid-users-add-post) — params: labelIds, groupIds, users
- `POST /api/v1/groups/{groupId}/users/remove` (api-v1-groups-by-groupid-users-remove-post) — params: userIds
- `POST /api/v1/groups` (api-v1-groups-post) — params: name, description, helpCenterId, logoId
- `GET /api/v1/helpCenters` (api-v1-helpcenters, read-only) — params: query
- `GET /api/v1/helpCenters/{helpcenterId}` (api-v1-helpcenters-by-helpcenterid, read-only) — params: params, query
- `POST /api/v1/helpCenters/{helpcenterId}/sitemaps` (api-v1-helpcenters-by-helpcenterid-sitemaps-post) — params: params, query
- `GET /api/v1/holidayList` (api-v1-holidaylist, read-only) — params: query
- `GET /api/v1/holidayList/{holidayListId}` (api-v1-holidaylist-by-holidaylistid, read-only) — params: params, query
- `PATCH /api/v1/holidayList/{holidayListId}` (api-v1-holidaylist-by-holidaylistid-patch) — params: associatedBusinessHourIds, holidays, name, status
- `POST /api/v1/holidayList` (api-v1-holidaylist-post) — params: associatedBusinessHourIds, holidays, name, status, year, holidayListType
- `GET /api/v1/im/bots` (api-v1-im-bots, read-only) — params: query
- `GET /api/v1/im/bots/{id}` (api-v1-im-bots-by-id, read-only) — params: params, query
- `GET /api/v1/im/cannedMessages` (api-v1-im-cannedmessages, read-only) — params: query
- `GET /api/v1/im/cannedMessages/{template_message_id}` (api-v1-im-cannedmessages-by-template-message-id, read-only) — params: params, query
- `POST /api/v1/im/cannedMessages/{template_message_id}/apply` (api-v1-im-cannedmessages-by-template-message-id-apply-post) — params: params, query
- `GET /api/v1/im/channels` (api-v1-im-channels, read-only) — params: query
- `POST /api/v1/im/channels/{channelId}/initiateSession` (api-v1-im-channels-by-channelid-initiatesession-post) — params: receiverId, receiverType, meta, cannedMessageId, language, message, headerMessage, urlMessage
- `POST /api/v1/im/channels/{channelId}/sessions` (api-v1-im-channels-by-channelid-sessions-post) — params: integrationServiceId, facebookMessengerPayload, meta
- `GET /api/v1/im/channels/{id}` (api-v1-im-channels-by-id, read-only) — params: params, query
- `POST /api/v1/im/channels` (api-v1-im-channels-post) — params: name, integrationServiceId, configParams, defaultBotId, isSandBox, meta
- `GET /api/v1/im/integrationServices` (api-v1-im-integrationservices, read-only) — params: query
- `GET /api/v1/im/integrationServices/{id}` (api-v1-im-integrationservices-by-id, read-only) — params: params, query
- `POST /api/v1/im/integrationServices/{id}/configParams/{configParamName}/computeOptions` (api-v1-im-integrationservices-by-id-configparams-by-configparamname-computeoptions-post) — params: configParams
- `GET /api/v1/im/integrationServices/WHATSAPP/details` (api-v1-im-integrationservices-whatsapp-details, read-only) — params: query
- `GET /api/v1/im/integrationServices/WHATSAPP/phonenumbers` (api-v1-im-integrationservices-whatsapp-phonenumbers, read-only) — params: query
- `GET /api/v1/im/integrationServices/WHATSAPP/phonenumbers/{phoneNumberId}/codeVerification` (api-v1-im-integrationservices-whatsapp-phonenumbers-by-phonenumberid-codeverification, read-only) — params: params, query
- `POST /api/v1/im/integrationServices/WHATSAPP/phonenumbers/{phoneNumberId}/codeVerification` (api-v1-im-integrationservices-whatsapp-phonenumbers-by-phonenumberid-codeverification-post) — params: otp
- `GET /api/v1/im/integrationServices/WHATSAPP/sandBoxTesters` (api-v1-im-integrationservices-whatsapp-sandboxtesters, read-only) — params: query
- `POST /api/v1/im/integrationServices/WHATSAPP/sandBoxTesters` (api-v1-im-integrationservices-whatsapp-sandboxtesters-post) — params: sandBoxTesters
- `GET /api/v1/im/integrationServices/WHATSAPP/templateCreditExhaustStatus` (api-v1-im-integrationservices-whatsapp-templatecreditexhauststatus, read-only) — params: query
- `POST /api/v1/im/integrationServices/WHATSAPP/templateLanguages` (api-v1-im-integrationservices-whatsapp-templatelanguages-post) — params: query
- `GET /api/v1/im/integrationServices/WHATSAPP/templateTags` (api-v1-im-integrationservices-whatsapp-templatetags, read-only) — params: query
- `GET /api/v1/im/messages/search` (api-v1-im-messages-search, read-only) — params: query
- `GET /api/v1/im/metrics/agents` (api-v1-im-metrics-agents, read-only) — params: query
- `GET /api/v1/im/metrics/conversations/timeseries` (api-v1-im-metrics-conversations-timeseries, read-only) — params: query
- `GET /api/v1/im/metrics/messages/timeseries` (api-v1-im-metrics-messages-timeseries, read-only) — params: query
- `GET /api/v1/im/metrics/payment/timeseries` (api-v1-im-metrics-payment-timeseries, read-only) — params: query
- `GET /api/v1/im/metrics/sessions/timeseries` (api-v1-im-metrics-sessions-timeseries, read-only) — params: query
- `GET /api/v1/im/sessions` (api-v1-im-sessions, read-only) — params: query
- `GET /api/v1/im/sessions/{id}` (api-v1-im-sessions-by-id, read-only) — params: params, query
- `PATCH /api/v1/im/sessions/{id}` (api-v1-im-sessions-by-id-patch) — params: agentId, botId, status
- `GET /api/v1/im/sessions/{id}/tickets` (api-v1-im-sessions-by-id-tickets, read-only) — params: params, query
- `GET /api/v1/im/sessions/{sid}/attachments` (api-v1-im-sessions-by-sid-attachments, read-only) — params: params, query
- `GET /api/v1/im/sessions/{sid}/attachments/{attachment_id}` (api-v1-im-sessions-by-sid-attachments-by-attachment-id, read-only) — params: params, query
- `POST /api/v1/im/sessions/{sid}/attachments` (api-v1-im-sessions-by-sid-attachments-post) — params: file
- `GET /api/v1/im/sessions/{sid}/messages` (api-v1-im-sessions-by-sid-messages, read-only) — params: params, query
- `GET /api/v1/im/sessions/{sid}/messages/{msg_id}` (api-v1-im-sessions-by-sid-messages-by-msg-id, read-only) — params: params, query
- `GET /api/v1/im/sessions/{sid}/messages/{msg_id}/fullContent` (api-v1-im-sessions-by-sid-messages-by-msg-id-fullcontent, read-only) — params: params, query
- `POST /api/v1/im/sessions/{sid}/messages` (api-v1-im-sessions-by-sid-messages-post) — params: replyToMessageId, message, location, meta
- `POST /api/v1/im/sessions/lastMessages` (api-v1-im-sessions-lastmessages-post) — params: sessionIds
- `GET /api/v1/im/sessions/metrics` (api-v1-im-sessions-metrics, read-only) — params: query
- `GET /api/v1/im/subscription/addOns` (api-v1-im-subscription-addons, read-only) — params: query
- `GET /api/v1/im/subscription/statement` (api-v1-im-subscription-statement, read-only) — params: query
- `POST /api/v1/importMappings` (api-v1-importmappings-post) — params: scopeId, module, externalIds
- `GET /api/v1/imports/{importId}` (api-v1-imports-by-importid, read-only) — params: params, query
- `POST /api/v1/imports` (api-v1-imports-post) — params: scopeId, data, runAutomation, groupId, notifyUrl
- `GET /api/v1/jiraIssue/{issueId}/tickets` (api-v1-jiraissue-by-issueid-tickets, read-only) — params: params, query
- `DELETE /api/v1/kbCategory/{categoryId}` (api-v1-kbcategory-by-categoryid-delete) — params: params, query
- `GET /api/v1/kbCategory/{categoryId}/repositionArticles` (api-v1-kbcategory-by-categoryid-repositionarticles, read-only) — params: params, query
- `POST /api/v1/kbCategory/{categoryId}/repositionArticles` (api-v1-kbcategory-by-categoryid-repositionarticles-post) — params: ids
- `GET /api/v1/kbCategory/trashedCategories` (api-v1-kbcategory-trashedcategories, read-only) — params: query
- `GET /api/v1/kbCategory/trashedCategories/count` (api-v1-kbcategory-trashedcategories-count, read-only) — params: query
- `POST /api/v1/kbCategoryLogo` (api-v1-kbcategorylogo-post) — params: file
- `POST /api/v1/kbComments/approve` (api-v1-kbcomments-approve-post) — params: ids
- `GET /api/v1/kbComments/moderatedComments` (api-v1-kbcomments-moderatedcomments, read-only) — params: query
- `GET /api/v1/kbComments/moderatedComments/count` (api-v1-kbcomments-moderatedcomments-count, read-only) — params: query
- `POST /api/v1/kbComments/moveToTrash` (api-v1-kbcomments-movetotrash-post) — params: ids
- `GET /api/v1/kbComments/trashedComments` (api-v1-kbcomments-trashedcomments, read-only) — params: query
- `GET /api/v1/kbComments/trashedComments/count` (api-v1-kbcomments-trashedcomments-count, read-only) — params: query
- `POST /api/v1/kbComments/trashedComments/delete` (api-v1-kbcomments-trashedcomments-delete-post) — params: ids
- `POST /api/v1/kbComments/trashedComments/restore` (api-v1-kbcomments-trashedcomments-restore-post) — params: ids
- `GET /api/v1/kbRootCategories` (api-v1-kbrootcategories, read-only) — params: query
- `GET /api/v1/kbRootCategories/{rootCategoryId}` (api-v1-kbrootcategories-by-rootcategoryid, read-only) — params: params, query
- `GET /api/v1/kbRootCategories/{rootCategoryId}/categoryTree` (api-v1-kbrootcategories-by-rootcategoryid-categorytree, read-only) — params: params, query
- `POST /api/v1/kbRootCategories/{rootCategoryId}/moderators/add` (api-v1-kbrootcategories-by-rootcategoryid-moderators-add-post) — params: moderatorIds
- `POST /api/v1/kbRootCategories/{rootCategoryId}/moderators/remove` (api-v1-kbrootcategories-by-rootcategoryid-moderators-remove-post) — params: moderatorIds
- `GET /api/v1/kbRootCategories/{rootCategoryId}/reviewOwners` (api-v1-kbrootcategories-by-rootcategoryid-reviewowners, read-only) — params: params, query
- `POST /api/v1/kbRootCategories/{rootCategoryId}/reviewOwners/add` (api-v1-kbrootcategories-by-rootcategoryid-reviewowners-add-post) — params: reviewOwnerIds
- `POST /api/v1/kbRootCategories/{rootCategoryId}/reviewOwners/remove` (api-v1-kbrootcategories-by-rootcategoryid-reviewowners-remove-post) — params: reviewOwnerIds
- `POST /api/v1/kbRootCategories/{rootCategoryId}/translations/{locale}/permalinks/add` (api-v1-kbrootcategories-by-rootcategoryid-translations-by-locale-permalinks-add-post) — params: isOldPermalinkNeeded, permalink
- `POST /api/v1/kbRootCategories/{rootCategoryId}/translations/{locale}/permalinks/remove` (api-v1-kbrootcategories-by-rootcategoryid-translations-by-locale-permalinks-remove-post) — params: permalink
- `GET /api/v1/kbRootCategories/categoryTreeByPermalink` (api-v1-kbrootcategories-categorytreebypermalink, read-only) — params: query
- `POST /api/v1/kbRootCategories` (api-v1-kbrootcategories-post) — params: articleViewType, visibility, description, feedbackTicketConversionPreference, associatedDepartmentIds, isReviewEnabled, translations, moderationType, groupIds, name, primaryDepartmentId, logoId, status, helpcenterId
- `POST /api/v1/kbRootCategories/reorder` (api-v1-kbrootcategories-reorder-post) — params: orderedCategoryIds, categoryPositions
- `GET /api/v1/kbSections/{sectionId}` (api-v1-kbsections-by-sectionid, read-only) — params: params, query
- `PATCH /api/v1/kbSections/{sectionId}` (api-v1-kbsections-by-sectionid-patch) — params: visibility, translations, groupIds, name, ipAddresses, status, description, logoId, articlePermission
- `POST /api/v1/kbSections/{sectionId}/translations/{locale}/permalinks/add` (api-v1-kbsections-by-sectionid-translations-by-locale-permalinks-add-post) — params: isOldPermalinkNeeded, permalink
- `POST /api/v1/kbSections/{sectionId}/translations/{locale}/permalinks` (api-v1-kbsections-by-sectionid-translations-by-locale-permalinks-post) — params: primaryPermalink, secondaryPermalinks
- `POST /api/v1/kbSections/{sectionId}/translations/{locale}/permalinks/remove` (api-v1-kbsections-by-sectionid-translations-by-locale-permalinks-remove-post) — params: permalink
- `POST /api/v1/kbSections` (api-v1-kbsections-post) — params: visibility, translations, groupIds, name, ipAddresses, status, parentCategoryId, description, logoId, articlePermission
- `POST /api/v1/kbSections/reorder` (api-v1-kbsections-reorder-post) — params: orderedCategoryIds, parentCategoryId, categoryPositions
- `GET /api/v1/labels` (api-v1-labels, read-only) — params: query
- `GET /api/v1/labels/{labelId}` (api-v1-labels-by-labelid, read-only) — params: params, query
- `DELETE /api/v1/labels/{labelId}` (api-v1-labels-by-labelid-delete) — params: params, query
- `PATCH /api/v1/labels/{labelId}` (api-v1-labels-by-labelid-patch) — params: preferences, name, logoId
- `GET /api/v1/labels/{labelId}/users` (api-v1-labels-by-labelid-users, read-only) — params: params, query
- `POST /api/v1/labels/{labelId}/users/add` (api-v1-labels-by-labelid-users-add-post) — params: userIds
- `POST /api/v1/labels/{labelId}/users/remove` (api-v1-labels-by-labelid-users-remove-post) — params: userIds
- `POST /api/v1/labels` (api-v1-labels-post) — params: preferences, name, logoId, helpCenterId
- `GET /api/v1/languages` (api-v1-languages, read-only)
- `GET /api/v1/lastAccessedView` (api-v1-lastaccessedview, read-only) — params: query
- `PUT /api/v1/lastAccessedView/{cvId}` (api-v1-lastaccessedview-by-cvid-put) — params: params, query
- `GET /api/v1/layoutRules` (api-v1-layoutrules, read-only) — params: query
- `GET /api/v1/layouts` (api-v1-layouts, read-only) — params: query
- `GET /api/v1/layouts/{layoutId}` (api-v1-layouts-by-layoutid, read-only) — params: params, query
- `POST /api/v1/layouts/{layoutId}/activate` (api-v1-layouts-by-layoutid-activate-post) — params: params, query
- `POST /api/v1/layouts/{layoutId}/clone` (api-v1-layouts-by-layoutid-clone-post) — params: skipDeptAccessValidation, layoutDisplayName, departmentId, isDefaultLayout, layoutDesc, layoutName
- `POST /api/v1/layouts/{layoutId}/deactivate` (api-v1-layouts-by-layoutid-deactivate-post) — params: transferToLayoutId
- `DELETE /api/v1/layouts/{layoutId}` (api-v1-layouts-by-layoutid-delete) — params: transferToLayoutId
- `POST /api/v1/layouts/{layoutId}/fields/{fieldId}/cloneFieldsInLayout` (api-v1-layouts-by-layoutid-fields-by-fieldid-clonefieldsinlayout-post) — params: layoutIds
- `GET /api/v1/layouts/{layoutId}/fields/{fieldId}/dependentValues` (api-v1-layouts-by-layoutid-fields-by-fieldid-dependentvalues, read-only) — params: params, query
- `PATCH /api/v1/layouts/{layoutId}/fields/{fieldId}` (api-v1-layouts-by-layoutid-fields-by-fieldid-patch) — params: allowedValues, defaultValue, sortBy, isMandatory, isNested
- `POST /api/v1/layouts/{layoutId}/fields/{fieldId}/unassociate` (api-v1-layouts-by-layoutid-fields-by-fieldid-unassociate-post) — params: params, query
- `GET /api/v1/layouts/{layoutId}/fields/{fieldId}/value` (api-v1-layouts-by-layoutid-fields-by-fieldid-value, read-only) — params: params, query
- `GET /api/v1/layouts/{layoutId}/layoutRules/{layoutRuleId}` (api-v1-layouts-by-layoutid-layoutrules-by-layoutruleid, read-only) — params: params, query
- `DELETE /api/v1/layouts/{layoutId}/layoutRules/{layoutRuleId}` (api-v1-layouts-by-layoutid-layoutrules-by-layoutruleid-delete) — params: params, query
- `PATCH /api/v1/layouts/{layoutId}/layoutRules/{layoutRuleId}` (api-v1-layouts-by-layoutid-layoutrules-by-layoutruleid-patch) — params: displayLabel, modifiedTime, fieldConditions, fieldName, description, systemGenerated, layoutId, executeInHelpCentre, createdBy, name, createdTime, modifiedBy, status
- `GET /api/v1/layouts/{layoutId}/layoutRules/criteriaFields` (api-v1-layouts-by-layoutid-layoutrules-criteriafields, read-only) — params: params, query
- `POST /api/v1/layouts/{layoutId}/layoutRules` (api-v1-layouts-by-layoutid-layoutrules-post) — params: displayLabel, modifiedTime, fieldConditions, fieldName, description, systemGenerated, layoutId, executeInHelpCentre, createdBy, name, createdTime, modifiedBy, status
- `PATCH /api/v1/layouts/{layoutId}` (api-v1-layouts-by-layoutid-patch) — params: skipDeptAccessValidation, departmentId, layoutDisplayName, module, isDefaultLayout, sections, layoutName, layoutDesc
- `GET /api/v1/layouts/{layoutId}/profiles` (api-v1-layouts-by-layoutid-profiles, read-only) — params: params, query
- `PATCH /api/v1/layouts/{layoutId}/profiles` (api-v1-layouts-by-layoutid-profiles-patch) — params: layoutProfileIds
- `POST /api/v1/layouts/{layoutId}/replaceValues` (api-v1-layouts-by-layoutid-replacevalues-post) — params: newValue, oldValue, fieldId
- `GET /api/v1/layouts/{layoutId}/validationRules/{validationRuleId}` (api-v1-layouts-by-layoutid-validationrules-by-validationruleid, read-only) — params: params, query
- `DELETE /api/v1/layouts/{layoutId}/validationRules/{validationRuleId}` (api-v1-layouts-by-layoutid-validationrules-by-validationruleid-delete) — params: params, query
- `PATCH /api/v1/layouts/{layoutId}/validationRules/{validationRuleId}` (api-v1-layouts-by-layoutid-validationrules-by-validationruleid-patch) — params: displayLabel, modifiedTime, fieldConditions, fieldName, executeInHelpCentre, createdBy, createdTime, modifiedBy, systemGenerated, layoutId, status
- `GET /api/v1/layouts/{layoutId}/validationRules/criteriaFields` (api-v1-layouts-by-layoutid-validationrules-criteriafields, read-only) — params: params, query
- `POST /api/v1/layouts/{layoutId}/validationRules` (api-v1-layouts-by-layoutid-validationrules-post) — params: displayLabel, modifiedTime, fieldConditions, fieldName, executeInHelpCentre, createdBy, createdTime, modifiedBy, systemGenerated, layoutId, status
- `POST /api/v1/layouts` (api-v1-layouts-post) — params: skipDeptAccessValidation, departmentId, layoutDisplayName, module, isDefaultLayout, sections, layoutName, layoutDesc
- `GET /api/v1/layouts/standardLayoutFormat` (api-v1-layouts-standardlayoutformat, read-only) — params: query
- `GET /api/v1/licenses/features` (api-v1-licenses-features, read-only) — params: query
- `GET /api/v1/licenses/plan` (api-v1-licenses-plan, read-only)
- `GET /api/v1/lightAgentProfile` (api-v1-lightagentprofile, read-only) — params: query
- `GET /api/v1/mailConfigurations` (api-v1-mailconfigurations, read-only) — params: query
- `PATCH /api/v1/mailConfigurations` (api-v1-mailconfigurations-patch) — params: createContactWithReplyTo, autoCCToMailbox, agentNameInTicketReply, createTicketForOriginalSender, privateThreadConfig
- `PUT /api/v1/mailConfigurations` (api-v1-mailconfigurations-put) — params: createContactWithReplyTo, autoCCToMailbox, agentNameInTicketReply, createTicketForOriginalSender, privateThreadConfig
- `GET /api/v1/mailReplyAddress` (api-v1-mailreplyaddress, read-only) — params: query
- `GET /api/v1/mailReplyAddress/{mailReplyAddressId}` (api-v1-mailreplyaddress-by-mailreplyaddressid, read-only) — params: params, query
- `DELETE /api/v1/mailReplyAddress/{mailReplyAddressId}` (api-v1-mailreplyaddress-by-mailreplyaddressid-delete) — params: params, query
- `PATCH /api/v1/mailReplyAddress/{mailReplyAddressId}` (api-v1-mailreplyaddress-by-mailreplyaddressid-patch) — params: displayName, departmentId, serviceProviderType, smtpDetails, isDepartmentDefault, isActive, isSmtpEnabled
- `POST /api/v1/mailReplyAddress/{mailReplyAddressId}/sendVerification` (api-v1-mailreplyaddress-by-mailreplyaddressid-sendverification-post) — params: params, query
- `POST /api/v1/mailReplyAddress` (api-v1-mailreplyaddress-post) — params: address, displayName, departmentId, serviceProviderType, smtpDetails, isDepartmentDefault, isSmtpEnabled
- `GET /api/v1/me/recentitems` (api-v1-me-recentitems, read-only) — params: query
- `POST /api/v1/me/recentitems/markRecent` (api-v1-me-recentitems-markrecent-post) — params: itemId
- `GET /api/v1/modules` (api-v1-modules, read-only) — params: query
- `GET /api/v1/myAccessibleModules` (api-v1-myaccessiblemodules, read-only) — params: query
- `GET /api/v1/myActiveTimers` (api-v1-myactivetimers, read-only) — params: query
- `GET /api/v1/myDepartments` (api-v1-mydepartments, read-only) — params: query
- `GET /api/v1/myEntityPreferences` (api-v1-myentitypreferences, read-only) — params: query
- `PATCH /api/v1/myEntityPreferences` (api-v1-myentitypreferences-patch) — params: data
- `GET /api/v1/myForm` (api-v1-myform, read-only) — params: query
- `GET /api/v1/myinfo` (api-v1-myinfo, read-only) — params: query
- `GET /api/v1/myPendingApprovals` (api-v1-mypendingapprovals, read-only) — params: query
- `GET /api/v1/myPreferences` (api-v1-mypreferences, read-only) — params: query
- `PATCH /api/v1/myPreferences` (api-v1-mypreferences-patch) — params: namePattern, currentDepartment, essp_displayContext, essp_displayMode, deskDatePattern, articleAutoSuggestion, keyBoardShortcuts, collapseSidePanel, extnticketrightpanel, extncontactrightpanel, extnaccountrightpanel, hideCurrentYearDate, pinAllAccounts, pinAllTickets, pinAllContacts, ticketConversationView, pinAllReports, pinAllDashboards, loadGettingStartedPage, contactsView, accountsView, ticketsView, tasksView, callsView, eventsView, activitiesView, defaultSendBehavior, loginLandingPage, timeFormat, newClient, authtokenDeprecationBanner, outBoxDelay, outBoxDelayTime, reportDurationFormat, ui_appearance, ui_lhsTheme, ui_pureDarkMode, ui_themes, ui_displayLayout, ui_displayLayoutWidth, ui_appFontFamily, ui_appFontSize, core_editorFontFamily, core_editorFontSize, core_isPublicComment, a11y_criticalLink, a11y_underlineLink, a11y_highlightClick, a11Y_animationControls, a11y_customScroll, a11y_zoomLevel, a11y_isFontSizeAdaptToZoom, a11y_needAccessibilityShortCutInWms, a11y_contrast, a11y_contrastLevel, a11y_isContrastRatioAdaptForBg, a11y_readingMask, a11y_readingMaskLevel, a11y_readingMaskHeight, a11y_readingMaskWidth, a11y_readingMaskOpacity, core_ticketReplyActions, core_ticketReplyActionsOrder, core_needEmptyQueueColumn, communityListViewMode, communityTopicsSortOrder, communityTopicsSortBy, communityTopicsRecordsPerPage, core_dviBarTabWidth, a11y_focusRing, a11y_focusRingEnabledPlaces, a11y_notificationView, a11y_isSuccessNotificationAutoClose, a11y_successNotifcationAutoCloseTime, a11y_isErrorNotificationAutoClose, a11y_errorNotificationAutoCloseTime, a11y_customCursor, a11y_customCursorSize, a11y_customCursorColor, a11y_adhdFriendly, a11y_astigmatism, a11y_blindness, a11y_colorBlindness, a11y_dyslexia, a11y_epilepsy, a11y_elderly, a11y_motorDisabilities, a11y_seizureSafe, a11y_visuallyImpaired, core_ticketsDvIbarPanelView, core_contactsDvIbarPanelView, core_accountsDvIbarPanelView, core_contractsDvIbarPanelView, core_callsDvIbarPanelView, core_tasksDvIbarPanelView, core_eventsDvIbarPanelView, core_isTicketReplySendAndUpdateStatus, ui_tagColorVariant, ui_isTagTextDefaultColor, core_ticketsTableViewContentStyle, core_contactsTableViewContentStyle, core_accountsTableViewContentStyle, core_contractsTableViewContentStyle, core_callsTableViewContentStyle, core_tasksTableViewContentStyle, core_eventsTableViewContentStyle, a11y_strikeThroughDisabledButton, a11y_switchLabel, feedNotificationFilterPreference, core_conversationNestedViewLineStyle, core_conversationNestedViewShowIcons, core_conversationViewType, core_threadCommentViewType, a11y_isSearchKeywordHighlighted, a11y_isHighlightedSearchKeywordProminent, a11y_mandatoryFieldIndication, a11y_mandatoryFieldLabelColor, a11y_colorFilter, a11y_grayScaleFilterExcludedPlaces, module_visibilityType
- `GET /api/v1/myProfile` (api-v1-myprofile, read-only) — params: query
- `GET /api/v1/myProfilePermissions` (api-v1-myprofilepermissions, read-only) — params: query
- `GET /api/v1/offlineAgents` (api-v1-offlineagents, read-only) — params: query
- `GET /api/v1/onlineAgents` (api-v1-onlineagents, read-only) — params: query
- `GET /api/v1/organizationFields` (api-v1-organizationfields, read-only) — params: query
- `GET /api/v1/organizationFields/{fieldId}` (api-v1-organizationfields-by-fieldid, read-only) — params: params, query
- `GET /api/v1/organizationFields/{fieldId}/criteriaReferences` (api-v1-organizationfields-by-fieldid-criteriareferences, read-only) — params: params, query
- `DELETE /api/v1/organizationFields/{fieldId}` (api-v1-organizationfields-by-fieldid-delete) — params: params, query
- `PATCH /api/v1/organizationFields/{fieldId}` (api-v1-organizationfields-by-fieldid-patch) — params: displayLabel, isTrackLastActivityTime, type, maxLength, isEncryptedField, name
- `GET /api/v1/organizationFields/{fieldId}/permissions` (api-v1-organizationfields-by-fieldid-permissions, read-only) — params: params, query
- `PATCH /api/v1/organizationFields/{fieldId}/permissions` (api-v1-organizationfields-by-fieldid-permissions-patch) — params: profiles
- `POST /api/v1/organizationFields` (api-v1-organizationfields-post) — params: displayLabel, isTrackLastActivityTime, type, maxLength, isEncryptedField, name
- `GET /api/v1/organizationModules` (api-v1-organizationmodules, read-only) — params: query
- `GET /api/v1/organizationModules/{moduleId}` (api-v1-organizationmodules-by-moduleid, read-only) — params: params, query
- `PUT /api/v1/organizationModules/{moduleId}` (api-v1-organizationmodules-by-moduleid-put) — params: description, profileIds, pluralLabel, departmentIds, singularLabel
- `POST /api/v1/organizationModules` (api-v1-organizationmodules-post) — params: description, profileIds, isDeptSpecific, pluralLabel, departmentIds, singularLabel
- `GET /api/v1/organizations` (api-v1-organizations, read-only)
- `GET /api/v1/organizations/{organizationId}` (api-v1-organizations-by-organizationid, read-only) — params: params, query
- `GET /api/v1/organizations/{organizationId}/favicon` (api-v1-organizations-by-organizationid-favicon, read-only) — params: params, query
- `DELETE /api/v1/organizations/{organizationId}/favicon` (api-v1-organizations-by-organizationid-favicon-delete) — params: params
- `POST /api/v1/organizations/{organizationId}/favicon` (api-v1-organizations-by-organizationid-favicon-post) — params: favicon
- `GET /api/v1/organizations/{organizationId}/logo` (api-v1-organizations-by-organizationid-logo, read-only) — params: params, query
- `DELETE /api/v1/organizations/{organizationId}/logo` (api-v1-organizations-by-organizationid-logo-delete) — params: params, query
- `POST /api/v1/organizations/{organizationId}/logo` (api-v1-organizations-by-organizationid-logo-post) — params: logo
- `PATCH /api/v1/organizations/{organizationId}` (api-v1-organizations-by-organizationid-patch) — params: zip, country, website, city, companyName, mobile, description, employeeCount, employeeCountRange, industry, timeZone, preferredSolution, migrationFrom, preferredCommunicationChannels, designation, referrerUrl, referrerFrom, ref_value, phoneNumber, portalName, street, primaryContact, currencyLocale, alias, state, fax, edition, signupType, ipAddress
- `POST /api/v1/organizations/markDefault` (api-v1-organizations-markdefault-post) — params: id
- `GET /api/v1/personalRole` (api-v1-personalrole, read-only) — params: query
- `POST /api/v1/portalUsers/{userId}/removeUser` (api-v1-portalusers-by-userid-removeuser-post) — params: params
- `GET /api/v1/products` (api-v1-products, read-only) — params: query
- `GET /api/v1/products/{productId}` (api-v1-products-by-productid, read-only) — params: params, query
- `GET /api/v1/products/{productId}/accounts` (api-v1-products-by-productid-accounts, read-only) — params: params, query
- `POST /api/v1/products/{productId}/associateAccounts` (api-v1-products-by-productid-associateaccounts-post) — params: ids, associate
- `POST /api/v1/products/{productId}/associateContacts` (api-v1-products-by-productid-associatecontacts-post) — params: ids, associate
- `GET /api/v1/products/{productId}/attachments` (api-v1-products-by-productid-attachments, read-only) — params: params, query
- `DELETE /api/v1/products/{productId}/attachments/{attachmentId}` (api-v1-products-by-productid-attachments-by-attachmentid-delete) — params: params, query
- `POST /api/v1/products/{productId}/attachments` (api-v1-products-by-productid-attachments-post) — params: file
- `GET /api/v1/products/{productId}/contacts` (api-v1-products-by-productid-contacts, read-only) — params: params, query
- `PATCH /api/v1/products/{productId}` (api-v1-products-by-productid-patch) — params: unitPrice, productCode, productName, departmentIds, cf, customFields, description, ownerId, productCategory, manufacturer, layoutId
- `GET /api/v1/products/{productId}/tickets` (api-v1-products-by-productid-tickets, read-only) — params: params, query
- `POST /api/v1/products/moveToTrash` (api-v1-products-movetotrash-post) — params: productIds, departmentId
- `POST /api/v1/products` (api-v1-products-post) — params: unitPrice, productCode, productName, departmentIds, cf, customFields, description, ownerId, productCategory, manufacturer, layoutId
- `GET /api/v1/products/search` (api-v1-products-search, read-only) — params: query
- `GET /api/v1/products/searchDuplicates` (api-v1-products-searchduplicates, read-only) — params: query
- `GET /api/v1/profiles` (api-v1-profiles, read-only) — params: query
- `GET /api/v1/profiles/{profileId}` (api-v1-profiles-by-profileid, read-only) — params: params, query
- `GET /api/v1/profiles/{profileId}/agents` (api-v1-profiles-by-profileid-agents, read-only) — params: params, query
- `POST /api/v1/profiles/{profileId}/clone` (api-v1-profiles-by-profileid-clone-post) — params: name, description
- `POST /api/v1/profiles/{profileId}/delete` (api-v1-profiles-by-profileid-delete-post) — params: transferToProfileId
- `PATCH /api/v1/profiles/{profileId}` (api-v1-profiles-by-profileid-patch) — params: permissions, name, description, editAllArticles, moderate, manageKB, admin, import, export, manageOwnCustomViews, shareOwnCustomViews, editSharedCustomViews, deleteSharedCustomViews, reshareSharedCustomViews
- `GET /api/v1/profiles/count` (api-v1-profiles-count, read-only) — params: query
- `GET /api/v1/recentTicketTags` (api-v1-recenttickettags, read-only) — params: query
- `POST /api/v1/recentTicketTags/{tagId}` (api-v1-recenttickettags-by-tagid-post) — params: params, query
- `GET /api/v1/recycleBin` (api-v1-recyclebin, read-only) — params: query
- `POST /api/v1/recycleBin/delete` (api-v1-recyclebin-delete-post) — params: ids
- `POST /api/v1/recycleBin/deleteAll` (api-v1-recyclebin-deleteall-post) — params: query
- `POST /api/v1/recycleBin/restore` (api-v1-recyclebin-restore-post) — params: isChildNeedToBeRestored, ids
- `POST /api/v1/recycleBin/restoreAll` (api-v1-recyclebin-restoreall-post) — params: query
- `GET /api/v1/roles` (api-v1-roles, read-only) — params: query
- `GET /api/v1/roles/{role_id}/teams` (api-v1-roles-by-role-id-teams, read-only) — params: params, query
- `GET /api/v1/roles/{roleId}` (api-v1-roles-by-roleid, read-only) — params: params, query
- `GET /api/v1/roles/{roleId}/agents` (api-v1-roles-by-roleid-agents, read-only) — params: params, query
- `POST /api/v1/roles/{roleId}/delete` (api-v1-roles-by-roleid-delete-post) — params: transferToRoleId
- `PATCH /api/v1/roles/{roleId}` (api-v1-roles-by-roleid-patch) — params: shareDataWithPeers, name, description, reportsTo
- `GET /api/v1/roles/count` (api-v1-roles-count, read-only) — params: query
- `POST /api/v1/roles` (api-v1-roles-post) — params: shareDataWithPeers, name, description, reportsTo
- `GET /api/v1/rolesByIds` (api-v1-rolesbyids, read-only) — params: query
- `GET /api/v1/routingPreferences` (api-v1-routingpreferences, read-only) — params: query
- `PATCH /api/v1/routingPreferences` (api-v1-routingpreferences-patch) — params: assignBacklog, assignToOfflineAgents, thresholdLimit, backLogLimit, isThresholdEnabled, isImmediateAssignmentEnabled, departmentId, assignBacklogsBy, freshTicketAssignMode, customThresholdVsAgents, isCustomThresholdEnabled
- `GET /api/v1/rulegroups` (api-v1-rulegroups, read-only) — params: query
- `PUT /api/v1/rulegroups/{id}` (api-v1-rulegroups-by-id-put) — params: id, name, description, engine, departmentProperties, module, events, rules
- `POST /api/v1/rulegroups/{id}/updateStatus` (api-v1-rulegroups-by-id-updatestatus-post)
- `GET /api/v1/rulegroups/executionLogs` (api-v1-rulegroups-executionlogs, read-only) — params: query
- `GET /api/v1/rulegroups/executionLogs/{id}` (api-v1-rulegroups-executionlogs-by-id, read-only) — params: params, query
- `POST /api/v1/rulegroups` (api-v1-rulegroups-post) — params: name, description, engine, departmentProperties, module, events, rules
- `GET /api/v1/search` (api-v1-search, read-only) — params: query
- `GET /api/v1/skillConfiguration` (api-v1-skillconfiguration, read-only) — params: query
- `PATCH /api/v1/skillConfiguration` (api-v1-skillconfiguration-patch) — params: autoSkillStamping, departmentId, attachSkillsOption
- `GET /api/v1/skills` (api-v1-skills, read-only) — params: query
- `GET /api/v1/skills/{skillId}` (api-v1-skills-by-skillid, read-only) — params: params, query
- `DELETE /api/v1/skills/{skillId}` (api-v1-skills-by-skillid-delete) — params: params, query
- `PATCH /api/v1/skills/{skillId}` (api-v1-skills-by-skillid-patch) — params: skillTypeId, agentIds, name, description, status, criteria
- `GET /api/v1/skills/{skillId}/relatedRules` (api-v1-skills-by-skillid-relatedrules, read-only) — params: params, query
- `GET /api/v1/skills/criteriaFields` (api-v1-skills-criteriafields, read-only) — params: query
- `POST /api/v1/skills/order` (api-v1-skills-order-post) — params: skillIds, departmentId
- `POST /api/v1/skills` (api-v1-skills-post) — params: skillTypeId, agentIds, criteria, name, description, status
- `GET /api/v1/skillTypes` (api-v1-skilltypes, read-only) — params: query
- `GET /api/v1/skillTypes/{skillTypeId}` (api-v1-skilltypes-by-skilltypeid, read-only) — params: params, query
- `DELETE /api/v1/skillTypes/{skillTypeId}` (api-v1-skilltypes-by-skilltypeid-delete) — params: params, query
- `PATCH /api/v1/skillTypes/{skillTypeId}` (api-v1-skilltypes-by-skilltypeid-patch) — params: name
- `POST /api/v1/skillTypes` (api-v1-skilltypes-post) — params: departmentId, name
- `POST /api/v1/Solutions/attachments` (api-v1-solutions-attachments-post) — params: file
- `GET /api/v1/Solutions/{articleId}/attachments` (api-v1-solutions-by-articleid-attachments, read-only) — params: params, query
- `DELETE /api/v1/Solutions/{articleId}/attachments` (api-v1-solutions-by-articleid-attachments-delete) — params: params, query
- `PATCH /api/v1/Solutions/{articleId}/attachments` (api-v1-solutions-by-articleid-attachments-patch) — params: file
- `PUT /api/v1/Solutions/{articleId}/attachments` (api-v1-solutions-by-articleid-attachments-put) — params: file
- `PATCH /api/v1/Solutions/{articleId}/feedbacks` (api-v1-solutions-by-articleid-feedbacks-patch) — params: departmentId, assigneeId, tags
- `PUT /api/v1/Solutions/{articleId}/feedbacks` (api-v1-solutions-by-articleid-feedbacks-put) — params: departmentId, assigneeId, tags
- `DELETE /api/v1/Solutions/feedbacks/{feedbackId}` (api-v1-solutions-feedbacks-by-feedbackid-delete) — params: params, query
- `GET /api/v1/Solutions/Search` (api-v1-solutions-search, read-only) — params: query
- `GET /api/v1/starredViews` (api-v1-starredviews, read-only) — params: query
- `POST /api/v1/starredViews/{cvId}/unstar` (api-v1-starredviews-by-cvid-unstar-post) — params: params, query
- `PUT /api/v1/starredViews/order` (api-v1-starredviews-order-put) — params: starredViewIds
- `GET /api/v1/subjectAccessRequests` (api-v1-subjectaccessrequests, read-only) — params: query
- `GET /api/v1/subjectAccessRequests/{sarId}` (api-v1-subjectaccessrequests-by-sarid, read-only) — params: params, query
- `POST /api/v1/subjectAccessRequests/count` (api-v1-subjectaccessrequests-count-post) — params: fieldConditions, contactEmailId, module
- `POST /api/v1/subjectAccessRequests/erase` (api-v1-subjectaccessrequests-erase-post) — params: contactEmailId, referenceTicketNumber, ids
- `POST /api/v1/subjectAccessRequests/eraseAll` (api-v1-subjectaccessrequests-eraseall-post) — params: fieldConditions, contactEmailId, module, referenceTicketNumber
- `POST /api/v1/subjectAccessRequests/export` (api-v1-subjectaccessrequests-export-post) — params: contactEmailId, referenceTicketNumber, ids
- `POST /api/v1/subjectAccessRequests/exportAll` (api-v1-subjectaccessrequests-exportall-post) — params: fieldConditions, contactEmailId, callBackUrl, module, referenceTicketNumber
- `GET /api/v1/subjectAccessRequests/fieldsAndConditions` (api-v1-subjectaccessrequests-fieldsandconditions, read-only) — params: query
- `GET /api/v1/supportEmailDomain` (api-v1-supportemaildomain, read-only) — params: query
- `PUT /api/v1/supportEmailDomain` (api-v1-supportemaildomain-put) — params: supportEmailDomain
- `GET /api/v1/supportPlans` (api-v1-supportplans, read-only) — params: query
- `GET /api/v1/supportPlans/{supportPlanId}` (api-v1-supportplans-by-supportplanid, read-only) — params: params, query
- `DELETE /api/v1/supportPlans/{supportPlanId}` (api-v1-supportplans-by-supportplanid-delete) — params: params, query
- `PATCH /api/v1/supportPlans/{supportPlanId}` (api-v1-supportplans-by-supportplanid-patch) — params: supportType, slaId, creditDetails, name, status
- `POST /api/v1/supportPlans` (api-v1-supportplans-post) — params: supportType, slaId, creditDetails, departmentId, name, status
- `PATCH /api/v1/tags/{currentTagId}/replace` (api-v1-tags-by-currenttagid-replace-patch) — params: id
- `GET /api/v1/tags/{tagId}/tickets` (api-v1-tags-by-tagid-tickets, read-only) — params: params, query
- `GET /api/v1/tags/search` (api-v1-tags-search, read-only) — params: query
- `GET /api/v1/tasks` (api-v1-tasks, read-only) — params: query
- `GET /api/v1/tasks/{activityId}/timer` (api-v1-tasks-by-activityid-timer, read-only) — params: params, query
- `GET /api/v1/tasks/{entityId}/activeTimer` (api-v1-tasks-by-entityid-activetimer, read-only) — params: params, query
- `GET /api/v1/tasks/{entityId}/comments` (api-v1-tasks-by-entityid-comments, read-only) — params: params, query
- `GET /api/v1/tasks/{entityId}/comments/{commentId}` (api-v1-tasks-by-entityid-comments-by-commentid, read-only) — params: params, query
- `PUT /api/v1/tasks/{entityId}/comments/{commentId}` (api-v1-tasks-by-entityid-comments-by-commentid-put) — params: contentType, content, attachmentIds
- `POST /api/v1/tasks/{entityId}/comments` (api-v1-tasks-by-entityid-comments-post) — params: contentType, content, attachmentIds
- `GET /api/v1/tasks/{taskId}` (api-v1-tasks-by-taskid, read-only) — params: params, query
- `GET /api/v1/tasks/{taskId}/attachments` (api-v1-tasks-by-taskid-attachments, read-only) — params: params, query
- `GET /api/v1/tasks/{taskId}/attachments/{attachmentId}/content` (api-v1-tasks-by-taskid-attachments-by-attachmentid-content, read-only) — params: params, query
- `DELETE /api/v1/tasks/{taskId}/attachments/{attachmentId}` (api-v1-tasks-by-taskid-attachments-by-attachmentid-delete) — params: params, query
- `POST /api/v1/tasks/{taskId}/attachments` (api-v1-tasks-by-taskid-attachments-post) — params: file
- `PATCH /api/v1/tasks/{taskId}` (api-v1-tasks-by-taskid-patch) — params: contactId, subject, departmentId, dueDate, ownerId, priority, ticketId, status, alertType, cf, customFields, category, description, teamId, reminder, layoutId
- `GET /api/v1/tasks/{taskId}/timeEntry` (api-v1-tasks-by-taskid-timeentry, read-only) — params: params, query
- `GET /api/v1/tasks/{taskId}/timeEntry/{taskTimeEntryId}` (api-v1-tasks-by-taskid-timeentry-by-tasktimeentryid, read-only) — params: params, query
- `PATCH /api/v1/tasks/{taskId}/timeEntry/{taskTimeEntryId}` (api-v1-tasks-by-taskid-timeentry-by-tasktimeentryid-patch) — params: secondsSpent, cf, executedTime, customFields, fixedCost, minutesSpent, agentCostPerHour, description, hoursSpent, ownerId, isBillable, mode, requestChargeType, additionalCost, totalCost, layoutId
- `POST /api/v1/tasks/{taskId}/timeEntry` (api-v1-tasks-by-taskid-timeentry-post) — params: secondsSpent, cf, executedTime, customFields, fixedCost, minutesSpent, agentCostPerHour, description, hoursSpent, ownerId, isBillable, mode, requestChargeType, additionalCost, totalCost, layoutId, invoiceId
- `GET /api/v1/tasks/{taskId}/timeEntrySummation` (api-v1-tasks-by-taskid-timeentrysummation, read-only) — params: params, query
- `POST /api/v1/tasks/{taskId}/timer` (api-v1-tasks-by-taskid-timer-post) — params: params, query
- `GET /api/v1/tasks/count` (api-v1-tasks-count, read-only) — params: query
- `POST /api/v1/tasks/deleteSpam` (api-v1-tasks-deletespam-post) — params: taskIds
- `POST /api/v1/tasks/emptySpam` (api-v1-tasks-emptyspam-post) — params: departmentId
- `POST /api/v1/tasks/moveToTrash` (api-v1-tasks-movetotrash-post) — params: entityIds
- `POST /api/v1/tasks` (api-v1-tasks-post) — params: contactId, subject, departmentId, dueDate, ownerId, priority, ticketId, status, alertType, cf, customFields, category, description, teamId, reminder, layoutId
- `GET /api/v1/tasks/search` (api-v1-tasks-search, read-only) — params: query
- `POST /api/v1/tasks/updateMany` (api-v1-tasks-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `GET /api/v1/teams` (api-v1-teams, read-only) — params: query
- `POST /api/v1/teams/{team_id}/deleteTeam` (api-v1-teams-by-team-id-deleteteam-post) — params: ticketNewAgent, ticketNewTeam, taskNewTeam, taskNewAgent
- `GET /api/v1/teams/{team_id}/members` (api-v1-teams-by-team-id-members, read-only) — params: params, query
- `PATCH /api/v1/teams/{team_id}` (api-v1-teams-by-team-id-patch) — params: roles, name, description, subTeams, agents, rolesWithSubordinates
- `GET /api/v1/teams/{teamId}` (api-v1-teams-by-teamid, read-only) — params: params, query
- `GET /api/v1/teams/{teamId}/associables` (api-v1-teams-by-teamid-associables, read-only) — params: params, query
- `POST /api/v1/teams` (api-v1-teams-post) — params: roles, departmentId, name, description, subTeams, agents, rolesWithSubordinates
- `GET /api/v1/templateFolders` (api-v1-templatefolders, read-only) — params: query
- `GET /api/v1/templateFolders/{folderId}` (api-v1-templatefolders-by-folderid, read-only) — params: params, query
- `DELETE /api/v1/templateFolders/{folderId}` (api-v1-templatefolders-by-folderid-delete) — params: params, query
- `PATCH /api/v1/templateFolders/{folderId}` (api-v1-templatefolders-by-folderid-patch) — params: folderDesc, folderAccessDetails, departmentId, folderName
- `PUT /api/v1/templateFolders/{folderId}` (api-v1-templatefolders-by-folderid-put) — params: folderDesc, folderAccessDetails, departmentId, folderName
- `POST /api/v1/templateFolders` (api-v1-templatefolders-post) — params: folderDesc, folderAccessDetails, departmentId, folderName
- `GET /api/v1/templates` (api-v1-templates, read-only) — params: query
- `GET /api/v1/templates/{emailTemplateId}` (api-v1-templates-by-emailtemplateid, read-only) — params: params, query
- `POST /api/v1/templates/{emailTemplateId}/cloneAttachments` (api-v1-templates-by-emailtemplateid-cloneattachments-post) — params: params, query
- `DELETE /api/v1/templates/{emailTemplateId}` (api-v1-templates-by-emailtemplateid-delete) — params: params, query
- `PATCH /api/v1/templates/{emailTemplateId}` (api-v1-templates-by-emailtemplateid-patch) — params: templateName, subject, recordType, departmentId, replyTo, attachmentIds, body, fromId, contentType, folderId
- `PUT /api/v1/templates/{emailTemplateId}` (api-v1-templates-by-emailtemplateid-put) — params: templateName, subject, recordType, departmentId, replyTo, attachmentIds, body, fromId, contentType, folderId
- `POST /api/v1/templates/{emailTemplateId}/render` (api-v1-templates-by-emailtemplateid-render-post) — params: source
- `GET /api/v1/templates/placeHolders` (api-v1-templates-placeholders, read-only) — params: query
- `POST /api/v1/templates` (api-v1-templates-post) — params: templateName, subject, recordType, departmentId, replyTo, attachmentIds, body, fromId, contentType, folderId
- `GET /api/v1/ticketQueueView/count` (api-v1-ticketqueueview-count, read-only) — params: query
- `GET /api/v1/tickets` (api-v1-tickets, read-only) — params: query
- `GET /api/v1/tickets/archivedTickets` (api-v1-tickets-archivedtickets, read-only) — params: query
- `GET /api/v1/tickets/{caseId}/timeEntry` (api-v1-tickets-by-caseid-timeentry, read-only) — params: params, query
- `GET /api/v1/tickets/{caseId}/timer` (api-v1-tickets-by-caseid-timer, read-only) — params: params, query
- `POST /api/v1/tickets/{caseId}/timer` (api-v1-tickets-by-caseid-timer-post) — params: params, query
- `GET /api/v1/tickets/{entityId}/activeTimer` (api-v1-tickets-by-entityid-activetimer, read-only) — params: params, query
- `GET /api/v1/tickets/{requestId}/threads/{threadId}/originalContent` (api-v1-tickets-by-requestid-threads-by-threadid-originalcontent, read-only) — params: params, query
- `GET /api/v1/tickets/{ticket_id}/blueprint` (api-v1-tickets-by-ticket-id-blueprint, read-only) — params: params, query
- `POST /api/v1/tickets/{ticket_id}/revokeBlueprint` (api-v1-tickets-by-ticket-id-revokeblueprint-post) — params: params, query
- `GET /api/v1/tickets/{ticket_id}/transitions/{transition_id}/attachments/{attachment_id}/content` (api-v1-tickets-by-ticket-id-transitions-by-transition-id-attachments-by-attachment-id-content, read-only) — params: params, query
- `DELETE /api/v1/tickets/{ticket_id}/transitions/{transition_id}/attachments/{attachment_id}` (api-v1-tickets-by-ticket-id-transitions-by-transition-id-attachments-by-attachment-id-delete) — params: params, query
- `POST /api/v1/tickets/{ticket_id}/transitions/{transition_id}/discardDraft` (api-v1-tickets-by-ticket-id-transitions-by-transition-id-discarddraft-post) — params: params, query
- `GET /api/v1/tickets/{ticket_id}/transitions/{transition_id}/form` (api-v1-tickets-by-ticket-id-transitions-by-transition-id-form, read-only) — params: params, query
- `POST /api/v1/tickets/{ticket_id}/transitions/{transition_id}/perform` (api-v1-tickets-by-ticket-id-transitions-by-transition-id-perform-post) — params: APPROVAL, RESOLUTION, ATTACHMENT, REPLY, COMMENT, SHARING, FIELD_UPDATE
- `POST /api/v1/tickets/{ticket_id}/transitions/{transition_id}/saveDraft` (api-v1-tickets-by-ticket-id-transitions-by-transition-id-savedraft-post) — params: ATTACHMENT, RESOLUTION, FIELD_UPDATE, APPROVAL, REPLY, COMMENT, SHARING
- `GET /api/v1/tickets/{ticketId}` (api-v1-tickets-by-ticketid, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/activities` (api-v1-tickets-by-ticketid-activities, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/addFollowers` (api-v1-tickets-by-ticketid-addfollowers-post) — params: followerIds
- `GET /api/v1/tickets/{ticketId}/approvals` (api-v1-tickets-by-ticketid-approvals, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/approvals/{approvalId}` (api-v1-tickets-by-ticketid-approvals-by-approvalid, read-only) — params: params, query
- `PATCH /api/v1/tickets/{ticketId}/approvals/{approvalId}` (api-v1-tickets-by-ticketid-approvals-by-approvalid-patch) — params: status, approverIds, subject, description
- `POST /api/v1/tickets/{ticketId}/approvals` (api-v1-tickets-by-ticketid-approvals-post) — params: approverIds, subject, description, status
- `GET /api/v1/tickets/{ticketId}/articleSuggestion` (api-v1-tickets-by-ticketid-articlesuggestion, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/associateTag` (api-v1-tickets-by-ticketid-associatetag-post) — params: tags
- `GET /api/v1/tickets/{ticketId}/attachments` (api-v1-tickets-by-ticketid-attachments, read-only) — params: params, query
- `DELETE /api/v1/tickets/{ticketId}/attachments/{attachmentId}` (api-v1-tickets-by-ticketid-attachments-by-attachmentid-delete) — params: params, query
- `PATCH /api/v1/tickets/{ticketId}/attachments/{attachmentId}` (api-v1-tickets-by-ticketid-attachments-by-attachmentid-patch) — params: isPublic
- `POST /api/v1/tickets/{ticketId}/attachments` (api-v1-tickets-by-ticketid-attachments-post) — params: file
- `GET /api/v1/tickets/{ticketId}/calls` (api-v1-tickets-by-ticketid-calls, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/comments` (api-v1-tickets-by-ticketid-comments, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/comments/{commentId}` (api-v1-tickets-by-ticketid-comments-by-commentid, read-only) — params: params, query
- `DELETE /api/v1/tickets/{ticketId}/comments/{commentId}` (api-v1-tickets-by-ticketid-comments-by-commentid-delete) — params: params, query
- `GET /api/v1/tickets/{ticketId}/comments/{commentId}/history` (api-v1-tickets-by-ticketid-comments-by-commentid-history, read-only) — params: params, query
- `PATCH /api/v1/tickets/{ticketId}/comments/{commentId}` (api-v1-tickets-by-ticketid-comments-by-commentid-patch) — params: content, isPublic, attachmentIds, contentType
- `POST /api/v1/tickets/{ticketId}/comments` (api-v1-tickets-by-ticketid-comments-post) — params: isPublic, attachmentIds, contentType, content
- `GET /api/v1/tickets/{ticketId}/conversations` (api-v1-tickets-by-ticketid-conversations, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/dissociateTag` (api-v1-tickets-by-ticketid-dissociatetag-post) — params: tags
- `DELETE /api/v1/tickets/{ticketId}/draftReply/{threadId}` (api-v1-tickets-by-ticketid-draftreply-by-threadid-delete) — params: params, query
- `PATCH /api/v1/tickets/{ticketId}/draftReply/{threadId}` (api-v1-tickets-by-ticketid-draftreply-by-threadid-patch) — params: channel, content, contentType, isPrivate, inReplyToThreadId, uploads, direction, cc, bcc, hasAttach, sendAsEmailMode, layoutId, cf, ticketStatus, attachmentIds, to, fromEmailAddress, isForward
- `POST /api/v1/tickets/{ticketId}/draftReply` (api-v1-tickets-by-ticketid-draftreply-post) — params: channel, content, contentType, isPrivate, inReplyToThreadId, uploads, direction, cc, bcc, hasAttach, sendAsEmailMode, layoutId, cf, ticketStatus, attachmentIds, to, fromEmailAddress, isForward
- `GET /api/v1/tickets/{ticketId}/events` (api-v1-tickets-by-ticketid-events, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/executeSkillbasedAssignment` (api-v1-tickets-by-ticketid-executeskillbasedassignment-post) — params: params, query
- `GET /api/v1/tickets/{ticketId}/followers` (api-v1-tickets-by-ticketid-followers, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/History` (api-v1-tickets-by-ticketid-history, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/latestThread` (api-v1-tickets-by-ticketid-latestthread, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/markAsRead` (api-v1-tickets-by-ticketid-markasread-post) — params: params, query
- `POST /api/v1/tickets/{ticketId}/markAsUnRead` (api-v1-tickets-by-ticketid-markasunread-post) — params: params, query
- `POST /api/v1/tickets/{ticketId}/merge` (api-v1-tickets-by-ticketid-merge-post) — params: ids, source
- `GET /api/v1/tickets/{ticketId}/metrics` (api-v1-tickets-by-ticketid-metrics, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/move` (api-v1-tickets-by-ticketid-move-post) — params: departmentId, forumId
- `POST /api/v1/tickets/{ticketId}/notifyArticleUsage` (api-v1-tickets-by-ticketid-notifyarticleusage-post) — params: ids
- `PATCH /api/v1/tickets/{ticketId}` (api-v1-tickets-by-ticketid-patch) — params: productId, phone, subject, dueDate, channel, language, priority, assigneeId, email, subCategory, cf, customFields, description, classification, category, status, sourceTicket, contactId, resolution, sharedDepartments, uploads, departmentId, contact, accountId, responseDueDate, webUrl, teamId, secondaryContacts, entitySkills, ticketCreationType, clonedTicketId, layoutId, parentTicket
- `GET /api/v1/tickets/{ticketId}/pins` (api-v1-tickets-by-ticketid-pins, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/pins` (api-v1-tickets-by-ticketid-pins-post) — params: isPublic, entityId, type
- `POST /api/v1/tickets/{ticketId}/pins/unpin` (api-v1-tickets-by-ticketid-pins-unpin-post) — params: ids
- `POST /api/v1/tickets/{ticketId}/recalculateSkills` (api-v1-tickets-by-ticketid-recalculateskills-post) — params: params, query
- `POST /api/v1/tickets/{ticketId}/removeFollowers` (api-v1-tickets-by-ticketid-removefollowers-post) — params: followerIds
- `POST /api/v1/tickets/{ticketId}/resendFailedThread` (api-v1-tickets-by-ticketid-resendfailedthread-post) — params: params, query
- `GET /api/v1/tickets/{ticketId}/resolution` (api-v1-tickets-by-ticketid-resolution, read-only) — params: params, query
- `DELETE /api/v1/tickets/{ticketId}/resolution` (api-v1-tickets-by-ticketid-resolution-delete) — params: params, query
- `PATCH /api/v1/tickets/{ticketId}/resolution` (api-v1-tickets-by-ticketid-resolution-patch) — params: isNotifyContact, content
- `GET /api/v1/tickets/{ticketId}/resolutionHistory` (api-v1-tickets-by-ticketid-resolutionhistory, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/sendDraft` (api-v1-tickets-by-ticketid-senddraft-post) — params: params, query
- `POST /api/v1/tickets/{ticketId}/sendReply` (api-v1-tickets-by-ticketid-sendreply-post) — params: channel, content, contentType, isPrivate, inReplyToThreadId, uploads, direction, cc, bcc, hasAttach, sendAsEmailMode, layoutId, cf, ticketStatus, attachmentIds, to, fromEmailAddress, isForward
- `GET /api/v1/tickets/{ticketId}/tags` (api-v1-tickets-by-ticketid-tags, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/tasks` (api-v1-tickets-by-ticketid-tasks, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/threads` (api-v1-tickets-by-ticketid-threads, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/threads/{threadId}` (api-v1-tickets-by-ticketid-threads-by-threadid, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/threads/{threadId}/attachments/{attachmentId}/content` (api-v1-tickets-by-ticketid-threads-by-threadid-attachments-by-attachmentid-content, read-only) — params: params, query
- `DELETE /api/v1/tickets/{ticketId}/threads/{threadId}/attachments/{attachmentId}` (api-v1-tickets-by-ticketid-threads-by-threadid-attachments-by-attachmentid-delete) — params: params, query
- `GET /api/v1/tickets/{ticketId}/threads/{threadId}/fullContent` (api-v1-tickets-by-ticketid-threads-by-threadid-fullcontent, read-only) — params: params, query
- `POST /api/v1/tickets/{ticketId}/threads/{threadId}/sendForReview` (api-v1-tickets-by-ticketid-threads-by-threadid-sendforreview-post) — params: params, query
- `POST /api/v1/tickets/{ticketId}/threads/{threadId}/split` (api-v1-tickets-by-ticketid-threads-by-threadid-split-post) — params: params, query
- `PUT /api/v1/tickets/{ticketId}/timeEntry/{teId}` (api-v1-tickets-by-ticketid-timeentry-by-teid-put) — params: secondsSpent, cf, executedTime, customFields, minutesSpent, agentCostPerHour, description, hoursSpent, ownerId, isBillable, billingType, requestChargeType, additionalCost, fixedCost, mode, layoutId
- `GET /api/v1/tickets/{ticketId}/timeEntry/{timeEntryId}` (api-v1-tickets-by-ticketid-timeentry-by-timeentryid, read-only) — params: params, query
- `DELETE /api/v1/tickets/{ticketId}/timeEntry/{timeEntryId}` (api-v1-tickets-by-ticketid-timeentry-by-timeentryid-delete) — params: params, query
- `POST /api/v1/tickets/{ticketId}/timeEntry` (api-v1-tickets-by-ticketid-timeentry-post) — params: secondsSpent, cf, executedTime, customFields, minutesSpent, agentCostPerHour, description, hoursSpent, ownerId, isBillable, billingType, requestChargeType, additionalCost, fixedCost, mode, layoutId, invoiceId
- `GET /api/v1/tickets/{ticketId}/timeEntryByBillingType` (api-v1-tickets-by-ticketid-timeentrybybillingtype, read-only) — params: params, query
- `GET /api/v1/tickets/{ticketId}/timeEntrySummation` (api-v1-tickets-by-ticketid-timeentrysummation, read-only) — params: params, query
- `POST /api/v1/tickets/deleteSpam` (api-v1-tickets-deletespam-post) — params: ticketIds
- `POST /api/v1/tickets/emptySpam` (api-v1-tickets-emptyspam-post) — params: departmentId
- `POST /api/v1/tickets/markSpam` (api-v1-tickets-markspam-post) — params: ids, isSpam, contactSpam, handleExistingTickets
- `POST /api/v1/tickets/moveToTrash` (api-v1-tickets-movetotrash-post) — params: ticketIds
- `POST /api/v1/tickets` (api-v1-tickets-post) — params: productId, phone, subject, dueDate, channel, language, priority, assigneeId, email, subCategory, cf, customFields, description, classification, category, status, sourceTicket, contactId, departmentId, contact, accountId, uploads, resolution, responseDueDate, webUrl, sharedDepartments, teamId, secondaryContacts, entitySkills, ticketCreationType, clonedTicketId, layoutId, parentTicket, blueprint
- `GET /api/v1/tickets/search` (api-v1-tickets-search, read-only) — params: query
- `POST /api/v1/tickets/updateMany` (api-v1-tickets-updatemany-post) — params: isCustomField, fieldName, ids, fieldValue
- `GET /api/v1/ticketsCount` (api-v1-ticketscount, read-only) — params: query
- `GET /api/v1/ticketsCountByFieldValues` (api-v1-ticketscountbyfieldvalues, read-only) — params: query
- `GET /api/v1/ticketTags` (api-v1-tickettags, read-only) — params: query
- `GET /api/v1/ticketTemplates` (api-v1-tickettemplates, read-only) — params: query
- `GET /api/v1/ticketTemplates/{ticketTemplateId}` (api-v1-tickettemplates-by-tickettemplateid, read-only) — params: params, query
- `PATCH /api/v1/ticketTemplates/{ticketTemplateId}` (api-v1-tickettemplates-by-tickettemplateid-patch) — params: showInCustomerPortal, ticketTemplateName, ticketTemplateValues, layoutId
- `POST /api/v1/ticketTemplates/deleteMany` (api-v1-tickettemplates-deletemany-post) — params: ids
- `POST /api/v1/ticketTemplates` (api-v1-tickettemplates-post) — params: showInCustomerPortal, ticketTemplateName, ticketTemplateValues, layoutId
- `GET /api/v1/timeTrackHistory` (api-v1-timetrackhistory, read-only) — params: query
- `GET /api/v1/timeTrackSettings` (api-v1-timetracksettings, read-only) — params: query
- `POST /api/v1/timeTrackSettings` (api-v1-timetracksettings-post) — params: ticketPreference, billingType, activityPreference, fixedCost, profiles, depId, isTimeTracking, isBillable, agents, timerAction
- `PUT /api/v1/timeTrackSettings` (api-v1-timetracksettings-put) — params: ticketPreference, billingType, activityPreference, fixedCost, profiles, depId, isTimeTracking, isBillable, agents, timerAction
- `GET /api/v1/timeZones` (api-v1-timezones, read-only)
- `POST /api/v1/uploadMyPhoto` (api-v1-uploadmyphoto-post) — params: userPhoto
- `POST /api/v1/uploads` (api-v1-uploads-post) — params: file
- `GET /api/v1/users` (api-v1-users, read-only) — params: query
- `GET /api/v1/users/{userId}` (api-v1-users-by-userid, read-only) — params: params, query
- `POST /api/v1/users/{userId}/anonymize` (api-v1-users-by-userid-anonymize-post) — params: anonymizedName
- `GET /api/v1/users/{userId}/badges` (api-v1-users-by-userid-badges, read-only) — params: params, query
- `POST /api/v1/users/{userId}/badges/associate` (api-v1-users-by-userid-badges-associate-post) — params: badgeIds
- `POST /api/v1/users/{userId}/badges/dissociate` (api-v1-users-by-userid-badges-dissociate-post) — params: badgeIds
- `GET /api/v1/users/{userId}/groups` (api-v1-users-by-userid-groups, read-only) — params: params, query
- `POST /api/v1/users/{userId}/groups/associate` (api-v1-users-by-userid-groups-associate-post) — params: groups
- `POST /api/v1/users/{userId}/groups/dissociate` (api-v1-users-by-userid-groups-dissociate-post) — params: groupIds
- `GET /api/v1/users/{userId}/labels` (api-v1-users-by-userid-labels, read-only) — params: params, query
- `POST /api/v1/users/{userId}/labels/assign` (api-v1-users-by-userid-labels-assign-post) — params: labels
- `POST /api/v1/users/{userId}/labels/remove` (api-v1-users-by-userid-labels-remove-post) — params: labelIds
- `PATCH /api/v1/users/{userId}` (api-v1-users-by-userid-patch) — params: email, status
- `GET /api/v1/validationRules` (api-v1-validationrules, read-only) — params: query
- `GET /api/v1/views` (api-v1-views, read-only) — params: query
- `POST /api/v1/views/{cvId}/star` (api-v1-views-by-cvid-star-post) — params: params, query
- `GET /api/v1/webhooks` (api-v1-webhooks, read-only) — params: query
- `GET /api/v1/webhooks/{webhookId}` (api-v1-webhooks-by-webhookid, read-only) — params: params, query
- `DELETE /api/v1/webhooks/{webhookId}` (api-v1-webhooks-by-webhookid-delete) — params: params, query
- `PATCH /api/v1/webhooks/{webhookId}` (api-v1-webhooks-by-webhookid-patch) — params: subscriptions, includeEventsFrom, isEnabled, name, description, ignoreSourceId, url
- `POST /api/v1/webhooks` (api-v1-webhooks-post) — params: subscriptions, includeEventsFrom, isEnabled, name, description, ignoreSourceId, url
- `GET /api/v1/zohoFinance/{financeService}/estimates` (api-v1-zohofinance-by-financeservice-estimates, read-only) — params: params, query
- `PATCH /api/v1/zohoFinance/{financeService}/estimates/{id}` (api-v1-zohofinance-by-financeservice-estimates-by-id-patch) — params: status
- `GET /api/v1/zohoFinance/{financeService}/invoices` (api-v1-zohofinance-by-financeservice-invoices, read-only) — params: params, query
- `PATCH /api/v1/zohoFinance/{financeService}/invoices/{id}` (api-v1-zohofinance-by-financeservice-invoices-by-id-patch) — params: status
- `POST /api/v1/zohoFinance/{financeService}/invoices/markAsSent` (api-v1-zohofinance-by-financeservice-invoices-markassent-post) — params: ids
- `GET /api/web/helpCenter/{helpCenterId}/samlConfigMetaData` (api-web-helpcenter-by-helpcenterid-samlconfigmetadata, read-only) — params: params, query

## Credential model

- Zoho API Console Client ID (`clientId`) — required
- Client Secret (`clientSecret`) — required — secret
- Refresh Token (`refreshToken`) — required — secret
- Data Center (com/eu/in/com.au/jp/ca/sa) (`dataCenter`)
- Desk organization ID (orgId header) (`orgId`) — required

## Optional

- [Apivom Atlas product page](https://apivom.com/en/products/atlas)
- [All Atlas integration guides](https://apivom.com/llms.txt)
- [Request a demo](https://apivom.com/en/contact?topic=demo&product=atlas)