Zendesk — ведущая платформа клиентского сервиса и поддержки, которая позволяет организациям эффективно управлять тикетами поддержки, пользователями и организациями через мощный набор инструментов и API. Интеграция Zendesk в AACFlow позволяет вашим агентам автоматизировать ключевые операции поддержки и синхронизировать данные поддержки с остальными процессами.
Интеграция Zendesk в AACFlow позволяет:
-
Управление тикетами:
- Получайте списки тикетов с расширенной фильтрацией и сортировкой.
- Получайте подробную информацию по конкретному тикету для отслеживания и решения.
- Создавайте новые тикеты по одному или массово, чтобы программно фиксировать обращения клиентов.
- Обновляйте тикеты по одному или массово, упрощая сложные процессы.
- Удаляйте или объединяйте тикеты по мере их решения или появления дубликатов.
-
Управление пользователями:
- Получайте списки пользователей или ищите их по критериям, чтобы поддерживать актуальность каталогов клиентов и агентов.
- Получайте подробную информацию о конкретном пользователе или о текущем авторизованном пользователе.
- Создавайте новых пользователей по одному или массово, автоматизируя подключение клиентов и агентов.
- Обновляйте данные пользователей по одному или массово для поддержания точности информации.
- Удаляйте пользователей по необходимости для соблюдения приватности или управления аккаунтами.
-
Управление организациями:
- Получайте список, ищите и автодополняйте организации для упрощённой поддержки и управления аккаунтами.
- Получайте детали организаций и поддерживайте базу в порядке.
- Создавайте, обновляйте или удаляйте организации, отражая изменения в клиентской базе.
- Выполняйте массовое создание организаций для масштабного онбординга.
-
Расширенный поиск и аналитика:
- Используйте универсальные эндпоинты поиска, чтобы быстро находить тикеты, пользователей или организации по любому полю.
- Получайте количество результатов поиска для отчётности и аналитики.
Используя интеграцию Zendesk в AACFlow, ваши автоматизированные воркфлоу могут бесшовно сортировать тикеты поддержки, управлять onboarding/offboarding пользователей, вести компании и обеспечивать стабильную работу службы поддержки. Будь то интеграция поддержки с продуктом, CRM или системами автоматизации — инструменты Zendesk в AACFlow дают надёжный программный контроль для лучшей в своём классе поддержки в масштабе.
Интегрируйте Zendesk в рабочий процесс. Может get tickets, get ticket, create ticket, create tickets bulk, update ticket, update tickets bulk, delete ticket, merge tickets, get users, get user, get current user, search users, create user, create users bulk, update user, update users bulk, delete user, get organizations, get organization, autocomplete organizations, create organization, create organizations bulk, update organization, delete organization, search, search count.
Получить список of tickets from Zendesk с optional фильтрация
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain (e.g., "mycompany" for mycompany.zendesk.com) |
status | string | Нет | Filter by status: "new", "open", "pending", "hold", "solved", or "closed" |
priority | string | Нет | Filter by priority: "low", "normal", "high", or "urgent" |
type | string | Нет | Filter by type: "problem", "incident", "question", or "task" |
assigneeId | string | Нет | Filter by assignee user ID as a numeric string (e.g., "12345") |
organizationId | string | Нет | Filter by organization ID as a numeric string (e.g., "67890") |
sort | string | Нет | Sort field for ticket listing (only applies without filters): "updated_at", "id", or "status". Prefix with "-" for descending (e.g., "-updated_at") |
perPage | string | Нет | Results per page as a number string (default: "100", max: "100") |
pageAfter | string | Нет | Cursor from a previous response to fetch the next page of results |
| Параметр | Тип | Описание |
|---|
tickets | array | Массив ticket objects |
↳ id | number | Automatically assigned ticket ID |
↳ url | string | API URL of the ticket |
↳ external_id | string | External ID for linking to external records |
↳ via | object | How the ticket was created |
↳ channel | string | Channel through which the ticket was created (e.g., email, web, api) |
↳ source | object | Source details for the channel |
↳ from | object | Information about the source sender |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the sender |
↳ to | object | Information about the recipient |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the recipient |
↳ rel | string | Relationship type |
↳ created_at | string | When the ticket was created (ISO 8601 format) |
↳ updated_at | string | When the ticket was last updated (ISO 8601 format) |
↳ type | string | Ticket type (problem, incident, question, task) |
↳ subject | string | Subject of the ticket |
↳ raw_subject | string | Subject of the ticket as entered by the requester |
↳ description | string | Read-only first comment on the ticket |
↳ priority | string | Priority level (low, normal, high, urgent) |
↳ status | string | Ticket status (new, open, pending, hold, solved, closed) |
↳ recipient | string | Original recipient email address |
↳ requester_id | number | User ID of the ticket requester |
↳ submitter_id | number | User ID of the ticket submitter |
↳ assignee_id | number | User ID of the agent assigned to the ticket |
↳ organization_id | number | Organization ID of the requester |
↳ group_id | number | Group ID assigned to the ticket |
↳ collaborator_ids | array | User IDs of collaborators (CC) |
↳ follower_ids | array | User IDs of followers |
↳ email_cc_ids | array | User IDs of email CCs |
↳ forum_topic_id | number | Topic ID in the community forum |
↳ problem_id | number | For incident tickets, the ID of the associated problem ticket |
↳ has_incidents | boolean | Произошла ли ticket has incident tickets linked |
↳ is_public | boolean | Произошла ли first comment is public |
↳ due_at | string | Due date for task tickets (ISO 8601 format) |
↳ tags | array | Tags associated С помощью ticket |
↳ custom_fields | array | Custom ticket fields |
↳ id | number | Custom field ID |
↳ value | string | Custom field value |
↳ custom_status_id | number | Custom status ID |
↳ satisfaction_rating | object | Customer satisfaction rating |
↳ id | number | Satisfaction rating ID |
↳ score | string | Rating score (e.g., good, bad, offered, unoffered) |
↳ comment | string | Comment left С помощью rating |
↳ sharing_agreement_ids | array | Sharing agreement IDs |
↳ followup_ids | array | IDs of follow-up tickets |
↳ brand_id | number | Brand ID the ticket belongs to |
↳ allow_attachments | boolean | Whether attachments are allowed |
↳ allow_channelback | boolean | Whether channelback is enabled |
↳ from_messaging_channel | boolean | Произошла ли ticket originated from a messaging channel |
↳ ticket_form_id | number | Ticket form ID |
↳ generated_timestamp | number | Unix timestamp of the ticket generation |
paging | object | Cursor-based постраничная выборка information |
↳ after_cursor | string | Cursor for fetching the next page of results |
↳ has_more | boolean | Whether more results are available |
↳ next_page | string | URL for next page of results |
metadata | object | Response metadata |
↳ total_returned | number | Number of items returned in this response |
↳ has_more | boolean | Whether more items are available |
Получить a single ticket от ID from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
ticketId | string | Да | Ticket ID to retrieve as a numeric string (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
ticket | object | Ticket object |
↳ id | number | Automatically assigned ticket ID |
↳ url | string | API URL of the ticket |
↳ external_id | string | External ID for linking to external records |
↳ via | object | How the ticket was created |
↳ channel | string | Channel through which the ticket was created (e.g., email, web, api) |
↳ source | object | Source details for the channel |
↳ from | object | Information about the source sender |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the sender |
↳ to | object | Information about the recipient |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the recipient |
↳ rel | string | Relationship type |
↳ created_at | string | When the ticket was created (ISO 8601 format) |
↳ updated_at | string | When the ticket was last updated (ISO 8601 format) |
↳ type | string | Ticket type (problem, incident, question, task) |
↳ subject | string | Subject of the ticket |
↳ raw_subject | string | Subject of the ticket as entered by the requester |
↳ description | string | Read-only first comment on the ticket |
↳ priority | string | Priority level (low, normal, high, urgent) |
↳ status | string | Ticket status (new, open, pending, hold, solved, closed) |
↳ recipient | string | Original recipient email address |
↳ requester_id | number | User ID of the ticket requester |
↳ submitter_id | number | User ID of the ticket submitter |
↳ assignee_id | number | User ID of the agent assigned to the ticket |
↳ organization_id | number | Organization ID of the requester |
↳ group_id | number | Group ID assigned to the ticket |
↳ collaborator_ids | array | User IDs of collaborators (CC) |
↳ follower_ids | array | User IDs of followers |
↳ email_cc_ids | array | User IDs of email CCs |
↳ forum_topic_id | number | Topic ID in the community forum |
↳ problem_id | number | For incident tickets, the ID of the associated problem ticket |
↳ has_incidents | boolean | Произошла ли ticket has incident tickets linked |
↳ is_public | boolean | Произошла ли first comment is public |
↳ due_at | string | Due date for task tickets (ISO 8601 format) |
↳ tags | array | Tags associated С помощью ticket |
↳ custom_fields | array | Custom ticket fields |
↳ id | number | Custom field ID |
↳ value | string | Custom field value |
↳ custom_status_id | number | Custom status ID |
↳ satisfaction_rating | object | Customer satisfaction rating |
↳ id | number | Satisfaction rating ID |
↳ score | string | Rating score (e.g., good, bad, offered, unoffered) |
↳ comment | string | Comment left С помощью rating |
↳ sharing_agreement_ids | array | Sharing agreement IDs |
↳ followup_ids | array | IDs of follow-up tickets |
↳ brand_id | number | Brand ID the ticket belongs to |
↳ allow_attachments | boolean | Whether attachments are allowed |
↳ allow_channelback | boolean | Whether channelback is enabled |
↳ from_messaging_channel | boolean | Произошла ли ticket originated from a messaging channel |
↳ ticket_form_id | number | Ticket form ID |
↳ generated_timestamp | number | Unix timestamp of the ticket generation |
ticket_id | number | The ticket ID |
Создать новый ticket in Zendesk с support для custom fields
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
subject | string | Нет | Ticket subject (optional - will be auto-generated if not provided) |
description | string | Да | Ticket description text (first comment) |
priority | string | Нет | Priority: "low", "normal", "high", or "urgent" |
status | string | Нет | Status: "new", "open", "pending", "hold", "solved", or "closed" |
type | string | Нет | Type: "problem", "incident", "question", or "task" |
tags | string | Нет | Comma-separated tags (e.g., "billing, urgent") |
assigneeId | string | Нет | Assignee user ID as a numeric string (e.g., "12345") |
groupId | string | Нет | Group ID as a numeric string (e.g., "67890") |
requesterId | string | Нет | Requester user ID as a numeric string (e.g., "11111") |
customFields | string | Нет | Custom fields as JSON object (e.g., {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
ticket | object | Created ticket object |
↳ id | number | Automatically assigned ticket ID |
↳ url | string | API URL of the ticket |
↳ external_id | string | External ID for linking to external records |
↳ via | object | How the ticket was created |
↳ channel | string | Channel through which the ticket was created (e.g., email, web, api) |
↳ source | object | Source details for the channel |
↳ from | object | Information about the source sender |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the sender |
↳ to | object | Information about the recipient |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the recipient |
↳ rel | string | Relationship type |
↳ created_at | string | When the ticket was created (ISO 8601 format) |
↳ updated_at | string | When the ticket was last updated (ISO 8601 format) |
↳ type | string | Ticket type (problem, incident, question, task) |
↳ subject | string | Subject of the ticket |
↳ raw_subject | string | Subject of the ticket as entered by the requester |
↳ description | string | Read-only first comment on the ticket |
↳ priority | string | Priority level (low, normal, high, urgent) |
↳ status | string | Ticket status (new, open, pending, hold, solved, closed) |
↳ recipient | string | Original recipient email address |
↳ requester_id | number | User ID of the ticket requester |
↳ submitter_id | number | User ID of the ticket submitter |
↳ assignee_id | number | User ID of the agent assigned to the ticket |
↳ organization_id | number | Organization ID of the requester |
↳ group_id | number | Group ID assigned to the ticket |
↳ collaborator_ids | array | User IDs of collaborators (CC) |
↳ follower_ids | array | User IDs of followers |
↳ email_cc_ids | array | User IDs of email CCs |
↳ forum_topic_id | number | Topic ID in the community forum |
↳ problem_id | number | For incident tickets, the ID of the associated problem ticket |
↳ has_incidents | boolean | Произошла ли ticket has incident tickets linked |
↳ is_public | boolean | Произошла ли first comment is public |
↳ due_at | string | Due date for task tickets (ISO 8601 format) |
↳ tags | array | Tags associated С помощью ticket |
↳ custom_fields | array | Custom ticket fields |
↳ id | number | Custom field ID |
↳ value | string | Custom field value |
↳ custom_status_id | number | Custom status ID |
↳ satisfaction_rating | object | Customer satisfaction rating |
↳ id | number | Satisfaction rating ID |
↳ score | string | Rating score (e.g., good, bad, offered, unoffered) |
↳ comment | string | Comment left С помощью rating |
↳ sharing_agreement_ids | array | Sharing agreement IDs |
↳ followup_ids | array | IDs of follow-up tickets |
↳ brand_id | number | Brand ID the ticket belongs to |
↳ allow_attachments | boolean | Whether attachments are allowed |
↳ allow_channelback | boolean | Whether channelback is enabled |
↳ from_messaging_channel | boolean | Произошла ли ticket originated from a messaging channel |
↳ ticket_form_id | number | Ticket form ID |
↳ generated_timestamp | number | Unix timestamp of the ticket generation |
ticket_id | number | The created ticket ID |
Создать multiple tickets in Zendesk at once (max 100)
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
tickets | string | Да | JSON array of ticket objects to create (max 100). Each ticket should have subject and comment properties (e.g., [{"subject": "Issue 1", "comment": {"body": "Description"}}]) |
| Параметр | Тип | Описание |
|---|
job_status | object | Job status object for bulk operations |
↳ id | string | Automatically assigned job ID |
↳ url | string | URL to poll for status updates |
↳ status | string | Current job status (queued, working, failed, completed) |
↳ job_type | string | Category of background task |
↳ total | number | Total number of tasks in this job |
↳ progress | number | Number of tasks already completed |
↳ message | string | Message from the job worker |
↳ results | array | Массив result objects from the job |
↳ id | number | ID of the created or updated resource |
↳ index | number | Position of the result in the batch |
↳ action | string | Action performed (e.g., create, update) |
↳ success | boolean | Произошла ли operation succeeded |
↳ status | string | Status message (e.g., Updated, Created) |
↳ error | string | Error message if operation failed |
job_id | string | The bulk operation job ID |
Обновитьn existing ticket in Zendesk с support для custom fields
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
ticketId | string | Да | Ticket ID to update as a numeric string (e.g., "12345") |
subject | string | Нет | New ticket subject text |
comment | string | Нет | Comment text to add to the ticket |
priority | string | Нет | Priority: "low", "normal", "high", or "urgent" |
status | string | Нет | Status: "new", "open", "pending", "hold", "solved", or "closed" |
type | string | Нет | Type: "problem", "incident", "question", or "task" |
tags | string | Нет | Comma-separated tags (e.g., "billing, urgent") |
assigneeId | string | Нет | Assignee user ID as a numeric string (e.g., "12345") |
groupId | string | Нет | Group ID as a numeric string (e.g., "67890") |
customFields | string | Нет | Custom fields as JSON object (e.g., {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
ticket | object | Updated ticket object |
↳ id | number | Automatically assigned ticket ID |
↳ url | string | API URL of the ticket |
↳ external_id | string | External ID for linking to external records |
↳ via | object | How the ticket was created |
↳ channel | string | Channel through which the ticket was created (e.g., email, web, api) |
↳ source | object | Source details for the channel |
↳ from | object | Information about the source sender |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the sender |
↳ to | object | Information about the recipient |
↳ address | string | Email address or other identifier |
↳ name | string | Name of the recipient |
↳ rel | string | Relationship type |
↳ created_at | string | When the ticket was created (ISO 8601 format) |
↳ updated_at | string | When the ticket was last updated (ISO 8601 format) |
↳ type | string | Ticket type (problem, incident, question, task) |
↳ subject | string | Subject of the ticket |
↳ raw_subject | string | Subject of the ticket as entered by the requester |
↳ description | string | Read-only first comment on the ticket |
↳ priority | string | Priority level (low, normal, high, urgent) |
↳ status | string | Ticket status (new, open, pending, hold, solved, closed) |
↳ recipient | string | Original recipient email address |
↳ requester_id | number | User ID of the ticket requester |
↳ submitter_id | number | User ID of the ticket submitter |
↳ assignee_id | number | User ID of the agent assigned to the ticket |
↳ organization_id | number | Organization ID of the requester |
↳ group_id | number | Group ID assigned to the ticket |
↳ collaborator_ids | array | User IDs of collaborators (CC) |
↳ follower_ids | array | User IDs of followers |
↳ email_cc_ids | array | User IDs of email CCs |
↳ forum_topic_id | number | Topic ID in the community forum |
↳ problem_id | number | For incident tickets, the ID of the associated problem ticket |
↳ has_incidents | boolean | Произошла ли ticket has incident tickets linked |
↳ is_public | boolean | Произошла ли first comment is public |
↳ due_at | string | Due date for task tickets (ISO 8601 format) |
↳ tags | array | Tags associated С помощью ticket |
↳ custom_fields | array | Custom ticket fields |
↳ id | number | Custom field ID |
↳ value | string | Custom field value |
↳ custom_status_id | number | Custom status ID |
↳ satisfaction_rating | object | Customer satisfaction rating |
↳ id | number | Satisfaction rating ID |
↳ score | string | Rating score (e.g., good, bad, offered, unoffered) |
↳ comment | string | Comment left С помощью rating |
↳ sharing_agreement_ids | array | Sharing agreement IDs |
↳ followup_ids | array | IDs of follow-up tickets |
↳ brand_id | number | Brand ID the ticket belongs to |
↳ allow_attachments | boolean | Whether attachments are allowed |
↳ allow_channelback | boolean | Whether channelback is enabled |
↳ from_messaging_channel | boolean | Произошла ли ticket originated from a messaging channel |
↳ ticket_form_id | number | Ticket form ID |
↳ generated_timestamp | number | Unix timestamp of the ticket generation |
ticket_id | number | The updated ticket ID |
Обновить multiple tickets in Zendesk at once (max 100)
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
ticketIds | string | Да | Comma-separated ticket IDs to update (max 100, e.g., "111, 222, 333") |
status | string | Нет | New status for all tickets: "new", "open", "pending", "hold", "solved", or "closed" |
priority | string | Нет | New priority for all tickets: "low", "normal", "high", or "urgent" |
assigneeId | string | Нет | New assignee ID for all tickets as a numeric string (e.g., "12345") |
groupId | string | Нет | New group ID for all tickets as a numeric string (e.g., "67890") |
tags | string | Нет | Comma-separated tags to add to all tickets (e.g., "bulk-update, processed") |
| Параметр | Тип | Описание |
|---|
job_status | object | Job status object for bulk operations |
↳ id | string | Automatically assigned job ID |
↳ url | string | URL to poll for status updates |
↳ status | string | Current job status (queued, working, failed, completed) |
↳ job_type | string | Category of background task |
↳ total | number | Total number of tasks in this job |
↳ progress | number | Number of tasks already completed |
↳ message | string | Message from the job worker |
↳ results | array | Массив result objects from the job |
↳ id | number | ID of the created or updated resource |
↳ index | number | Position of the result in the batch |
↳ action | string | Action performed (e.g., create, update) |
↳ success | boolean | Произошла ли operation succeeded |
↳ status | string | Status message (e.g., Updated, Created) |
↳ error | string | Error message if operation failed |
job_id | string | The bulk operation job ID |
Удалить ticket from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
ticketId | string | Да | Ticket ID to delete as a numeric string (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Deletion success |
ticket_id | string | The deleted ticket ID |
Merge multiple tickets into a target ticket
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
targetTicketId | string | Да | Target ticket ID as a numeric string (tickets will be merged into this one, e.g., "12345") |
sourceTicketIds | string | Да | Comma-separated source ticket IDs to merge (e.g., "111, 222, 333") |
targetComment | string | Нет | Comment text to add to target ticket after merge |
| Параметр | Тип | Описание |
|---|
job_status | object | Job status object for bulk operations |
↳ id | string | Automatically assigned job ID |
↳ url | string | URL to poll for status updates |
↳ status | string | Current job status (queued, working, failed, completed) |
↳ job_type | string | Category of background task |
↳ total | number | Total number of tasks in this job |
↳ progress | number | Number of tasks already completed |
↳ message | string | Message from the job worker |
↳ results | array | Массив result objects from the job |
↳ id | number | ID of the created or updated resource |
↳ index | number | Position of the result in the batch |
↳ action | string | Action performed (e.g., create, update) |
↳ success | boolean | Произошла ли operation succeeded |
↳ status | string | Status message (e.g., Updated, Created) |
↳ error | string | Error message if operation failed |
job_id | string | The merge job ID |
target_ticket_id | string | The target ticket ID that tickets were merged into |
Получить список of users from Zendesk с optional фильтрация
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain (e.g., "mycompany" for mycompany.zendesk.com) |
role | string | Нет | Filter by role: "end-user", "agent", or "admin" |
permissionSet | string | Нет | Filter by permission set ID as a numeric string (e.g., "12345") |
perPage | string | Нет | Results per page as a number string (default: "100", max: "100") |
pageAfter | string | Нет | Cursor from a previous response to fetch the next page of results |
| Параметр | Тип | Описание |
|---|
users | array | Массив user objects |
↳ id | number | Automatically assigned user ID |
↳ url | string | API URL of the user |
↳ name | string | User name |
↳ email | string | Primary email address |
↳ created_at | string | When the user was created (ISO 8601 format) |
↳ updated_at | string | When the user was last updated (ISO 8601 format) |
↳ time_zone | string | Time zone (e.g., Eastern Time (US & Canada)) |
↳ iana_time_zone | string | IANA time zone (e.g., America/New_York) |
↳ phone | string | Phone number |
↳ shared_phone_number | boolean | Произошла ли phone number is shared |
↳ photo | object | User photo details |
↳ content_url | string | URL to the photo |
↳ file_name | string | Photo file name |
↳ size | number | File size in bytes |
↳ locale | string | Locale (e.g., en-US) |
↳ locale_id | number | Locale ID |
↳ organization_id | number | Primary organization ID |
↳ role | string | User role (end-user, agent, admin) |
↳ role_type | number | Role type identifier |
↳ custom_role_id | number | Custom role ID |
↳ active | boolean | Произошла ли user is active (false if deleted) |
↳ verified | boolean | Whether any user identity has been verified |
↳ alias | string | Alias displayed to end users |
↳ details | string | Details about the user |
↳ notes | string | Notes about the user |
↳ signature | string | User signature for email replies |
↳ default_group_id | number | Default group ID for the user |
↳ tags | array | Tags associated С помощью user |
↳ external_id | string | External ID for linking to external records |
↳ restricted_agent | boolean | Произошла ли agent has restrictions |
↳ suspended | boolean | Произошла ли user is suspended |
↳ moderator | boolean | Произошла ли user has moderator permissions |
↳ chat_only | boolean | Произошла ли user is a chat-only agent |
↳ only_private_comments | boolean | Произошла ли user can only create private comments |
↳ two_factor_auth_enabled | boolean | Whether two-factor auth is enabled |
↳ last_login_at | string | Last login time (ISO 8601 format) |
↳ ticket_restriction | string | Ticket access restriction (organization, groups, assigned, requested) |
↳ user_fields | json | Custom user fields (dynamic key-value pairs) |
↳ shared | boolean | Произошла ли user is shared from a different Zendesk |
↳ shared_agent | boolean | Произошла ли agent is shared from a different Zendesk |
↳ remote_photo_url | string | URL to a remote photo |
paging | object | Cursor-based постраничная выборка information |
↳ after_cursor | string | Cursor for fetching the next page of results |
↳ has_more | boolean | Whether more results are available |
↳ next_page | string | URL for next page of results |
metadata | object | Response metadata |
↳ total_returned | number | Number of items returned in this response |
↳ has_more | boolean | Whether more items are available |
Получить a single user от ID from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
userId | string | Да | User ID to retrieve as a numeric string (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
user | object | User object |
↳ id | number | Automatically assigned user ID |
↳ url | string | API URL of the user |
↳ name | string | User name |
↳ email | string | Primary email address |
↳ created_at | string | When the user was created (ISO 8601 format) |
↳ updated_at | string | When the user was last updated (ISO 8601 format) |
↳ time_zone | string | Time zone (e.g., Eastern Time (US & Canada)) |
↳ iana_time_zone | string | IANA time zone (e.g., America/New_York) |
↳ phone | string | Phone number |
↳ shared_phone_number | boolean | Произошла ли phone number is shared |
↳ photo | object | User photo details |
↳ content_url | string | URL to the photo |
↳ file_name | string | Photo file name |
↳ size | number | File size in bytes |
↳ locale | string | Locale (e.g., en-US) |
↳ locale_id | number | Locale ID |
↳ organization_id | number | Primary organization ID |
↳ role | string | User role (end-user, agent, admin) |
↳ role_type | number | Role type identifier |
↳ custom_role_id | number | Custom role ID |
↳ active | boolean | Произошла ли user is active (false if deleted) |
↳ verified | boolean | Whether any user identity has been verified |
↳ alias | string | Alias displayed to end users |
↳ details | string | Details about the user |
↳ notes | string | Notes about the user |
↳ signature | string | User signature for email replies |
↳ default_group_id | number | Default group ID for the user |
↳ tags | array | Tags associated С помощью user |
↳ external_id | string | External ID for linking to external records |
↳ restricted_agent | boolean | Произошла ли agent has restrictions |
↳ suspended | boolean | Произошла ли user is suspended |
↳ moderator | boolean | Произошла ли user has moderator permissions |
↳ chat_only | boolean | Произошла ли user is a chat-only agent |
↳ only_private_comments | boolean | Произошла ли user can only create private comments |
↳ two_factor_auth_enabled | boolean | Whether two-factor auth is enabled |
↳ last_login_at | string | Last login time (ISO 8601 format) |
↳ ticket_restriction | string | Ticket access restriction (organization, groups, assigned, requested) |
↳ user_fields | json | Custom user fields (dynamic key-value pairs) |
↳ shared | boolean | Произошла ли user is shared from a different Zendesk |
↳ shared_agent | boolean | Произошла ли agent is shared from a different Zendesk |
↳ remote_photo_url | string | URL to a remote photo |
user_id | number | The user ID |
Получить currently authenticated user from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
| Параметр | Тип | Описание |
|---|
user | object | Current user object |
↳ id | number | Automatically assigned user ID |
↳ url | string | API URL of the user |
↳ name | string | User name |
↳ email | string | Primary email address |
↳ created_at | string | When the user was created (ISO 8601 format) |
↳ updated_at | string | When the user was last updated (ISO 8601 format) |
↳ time_zone | string | Time zone (e.g., Eastern Time (US & Canada)) |
↳ iana_time_zone | string | IANA time zone (e.g., America/New_York) |
↳ phone | string | Phone number |
↳ shared_phone_number | boolean | Произошла ли phone number is shared |
↳ photo | object | User photo details |
↳ content_url | string | URL to the photo |
↳ file_name | string | Photo file name |
↳ size | number | File size in bytes |
↳ locale | string | Locale (e.g., en-US) |
↳ locale_id | number | Locale ID |
↳ organization_id | number | Primary organization ID |
↳ role | string | User role (end-user, agent, admin) |
↳ role_type | number | Role type identifier |
↳ custom_role_id | number | Custom role ID |
↳ active | boolean | Произошла ли user is active (false if deleted) |
↳ verified | boolean | Whether any user identity has been verified |
↳ alias | string | Alias displayed to end users |
↳ details | string | Details about the user |
↳ notes | string | Notes about the user |
↳ signature | string | User signature for email replies |
↳ default_group_id | number | Default group ID for the user |
↳ tags | array | Tags associated С помощью user |
↳ external_id | string | External ID for linking to external records |
↳ restricted_agent | boolean | Произошла ли agent has restrictions |
↳ suspended | boolean | Произошла ли user is suspended |
↳ moderator | boolean | Произошла ли user has moderator permissions |
↳ chat_only | boolean | Произошла ли user is a chat-only agent |
↳ only_private_comments | boolean | Произошла ли user can only create private comments |
↳ two_factor_auth_enabled | boolean | Whether two-factor auth is enabled |
↳ last_login_at | string | Last login time (ISO 8601 format) |
↳ ticket_restriction | string | Ticket access restriction (organization, groups, assigned, requested) |
↳ user_fields | json | Custom user fields (dynamic key-value pairs) |
↳ shared | boolean | Произошла ли user is shared from a different Zendesk |
↳ shared_agent | boolean | Произошла ли agent is shared from a different Zendesk |
↳ remote_photo_url | string | URL to a remote photo |
user_id | number | The current user ID |
Поиск users in Zendesk using a запрос string
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
query | string | Нет | Search query string (e.g., user name or email) |
externalId | string | Нет | External ID to search by (your system identifier) |
perPage | string | Нет | Results per page as a number string (default: "100", max: "100") |
page | string | Нет | Page number for постраничная выборка (1-based) |
| Параметр | Тип | Описание |
|---|
users | array | Массив user objects |
↳ id | number | Automatically assigned user ID |
↳ url | string | API URL of the user |
↳ name | string | User name |
↳ email | string | Primary email address |
↳ created_at | string | When the user was created (ISO 8601 format) |
↳ updated_at | string | When the user was last updated (ISO 8601 format) |
↳ time_zone | string | Time zone (e.g., Eastern Time (US & Canada)) |
↳ iana_time_zone | string | IANA time zone (e.g., America/New_York) |
↳ phone | string | Phone number |
↳ shared_phone_number | boolean | Произошла ли phone number is shared |
↳ photo | object | User photo details |
↳ content_url | string | URL to the photo |
↳ file_name | string | Photo file name |
↳ size | number | File size in bytes |
↳ locale | string | Locale (e.g., en-US) |
↳ locale_id | number | Locale ID |
↳ organization_id | number | Primary organization ID |
↳ role | string | User role (end-user, agent, admin) |
↳ role_type | number | Role type identifier |
↳ custom_role_id | number | Custom role ID |
↳ active | boolean | Произошла ли user is active (false if deleted) |
↳ verified | boolean | Whether any user identity has been verified |
↳ alias | string | Alias displayed to end users |
↳ details | string | Details about the user |
↳ notes | string | Notes about the user |
↳ signature | string | User signature for email replies |
↳ default_group_id | number | Default group ID for the user |
↳ tags | array | Tags associated С помощью user |
↳ external_id | string | External ID for linking to external records |
↳ restricted_agent | boolean | Произошла ли agent has restrictions |
↳ suspended | boolean | Произошла ли user is suspended |
↳ moderator | boolean | Произошла ли user has moderator permissions |
↳ chat_only | boolean | Произошла ли user is a chat-only agent |
↳ only_private_comments | boolean | Произошла ли user can only create private comments |
↳ two_factor_auth_enabled | boolean | Whether two-factor auth is enabled |
↳ last_login_at | string | Last login time (ISO 8601 format) |
↳ ticket_restriction | string | Ticket access restriction (organization, groups, assigned, requested) |
↳ user_fields | json | Custom user fields (dynamic key-value pairs) |
↳ shared | boolean | Произошла ли user is shared from a different Zendesk |
↳ shared_agent | boolean | Произошла ли agent is shared from a different Zendesk |
↳ remote_photo_url | string | URL to a remote photo |
paging | object | Cursor-based постраничная выборка information |
↳ after_cursor | string | Cursor for fetching the next page of results |
↳ has_more | boolean | Whether more results are available |
↳ next_page | string | URL for next page of results |
metadata | object | Response metadata |
↳ total_returned | number | Number of items returned in this response |
↳ has_more | boolean | Whether more items are available |
Создать новый user in Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
name | string | Да | User full name (e.g., "John Smith") |
userEmail | string | Нет | User email address (e.g., "john@example.com") |
role | string | Нет | User role: "end-user", "agent", or "admin" |
phone | string | Нет | User phone number (e.g., "+1-555-123-4567") |
organizationId | string | Нет | Organization ID as a numeric string (e.g., "12345") |
verified | string | Нет | Set to "true" to skip email verification, or "false" otherwise |
tags | string | Нет | Comma-separated tags (e.g., "vip, enterprise") |
customFields | string | Нет | Custom fields as JSON object (e.g., {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
user | object | Created user object |
↳ id | number | Automatically assigned user ID |
↳ url | string | API URL of the user |
↳ name | string | User name |
↳ email | string | Primary email address |
↳ created_at | string | When the user was created (ISO 8601 format) |
↳ updated_at | string | When the user was last updated (ISO 8601 format) |
↳ time_zone | string | Time zone (e.g., Eastern Time (US & Canada)) |
↳ iana_time_zone | string | IANA time zone (e.g., America/New_York) |
↳ phone | string | Phone number |
↳ shared_phone_number | boolean | Произошла ли phone number is shared |
↳ photo | object | User photo details |
↳ content_url | string | URL to the photo |
↳ file_name | string | Photo file name |
↳ size | number | File size in bytes |
↳ locale | string | Locale (e.g., en-US) |
↳ locale_id | number | Locale ID |
↳ organization_id | number | Primary organization ID |
↳ role | string | User role (end-user, agent, admin) |
↳ role_type | number | Role type identifier |
↳ custom_role_id | number | Custom role ID |
↳ active | boolean | Произошла ли user is active (false if deleted) |
↳ verified | boolean | Whether any user identity has been verified |
↳ alias | string | Alias displayed to end users |
↳ details | string | Details about the user |
↳ notes | string | Notes about the user |
↳ signature | string | User signature for email replies |
↳ default_group_id | number | Default group ID for the user |
↳ tags | array | Tags associated С помощью user |
↳ external_id | string | External ID for linking to external records |
↳ restricted_agent | boolean | Произошла ли agent has restrictions |
↳ suspended | boolean | Произошла ли user is suspended |
↳ moderator | boolean | Произошла ли user has moderator permissions |
↳ chat_only | boolean | Произошла ли user is a chat-only agent |
↳ only_private_comments | boolean | Произошла ли user can only create private comments |
↳ two_factor_auth_enabled | boolean | Whether two-factor auth is enabled |
↳ last_login_at | string | Last login time (ISO 8601 format) |
↳ ticket_restriction | string | Ticket access restriction (organization, groups, assigned, requested) |
↳ user_fields | json | Custom user fields (dynamic key-value pairs) |
↳ shared | boolean | Произошла ли user is shared from a different Zendesk |
↳ shared_agent | boolean | Произошла ли agent is shared from a different Zendesk |
↳ remote_photo_url | string | URL to a remote photo |
user_id | number | The created user ID |
Создать multiple users in Zendesk using bulk import
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
users | string | Да | JSON array of user objects to create (e.g., [{"name": "User1", "email": "user1@example.com"}]) |
| Параметр | Тип | Описание |
|---|
job_status | object | Job status object for bulk operations |
↳ id | string | Automatically assigned job ID |
↳ url | string | URL to poll for status updates |
↳ status | string | Current job status (queued, working, failed, completed) |
↳ job_type | string | Category of background task |
↳ total | number | Total number of tasks in this job |
↳ progress | number | Number of tasks already completed |
↳ message | string | Message from the job worker |
↳ results | array | Массив result objects from the job |
↳ id | number | ID of the created or updated resource |
↳ index | number | Position of the result in the batch |
↳ action | string | Action performed (e.g., create, update) |
↳ success | boolean | Произошла ли operation succeeded |
↳ status | string | Status message (e.g., Updated, Created) |
↳ error | string | Error message if operation failed |
job_id | string | The bulk operation job ID |
Обновитьn existing user in Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
userId | string | Да | User ID to update as a numeric string (e.g., "12345") |
name | string | Нет | New user full name (e.g., "John Smith") |
userEmail | string | Нет | New user email address (e.g., "john@example.com") |
role | string | Нет | User role: "end-user", "agent", or "admin" |
phone | string | Нет | User phone number (e.g., "+1-555-123-4567") |
organizationId | string | Нет | Organization ID as a numeric string (e.g., "67890") |
verified | string | Нет | Set to "true" to mark user as verified, or "false" otherwise |
tags | string | Нет | Comma-separated tags (e.g., "vip, enterprise") |
customFields | string | Нет | Custom fields as JSON object (e.g., {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
user | object | Updated user object |
↳ id | number | Automatically assigned user ID |
↳ url | string | API URL of the user |
↳ name | string | User name |
↳ email | string | Primary email address |
↳ created_at | string | When the user was created (ISO 8601 format) |
↳ updated_at | string | When the user was last updated (ISO 8601 format) |
↳ time_zone | string | Time zone (e.g., Eastern Time (US & Canada)) |
↳ iana_time_zone | string | IANA time zone (e.g., America/New_York) |
↳ phone | string | Phone number |
↳ shared_phone_number | boolean | Произошла ли phone number is shared |
↳ photo | object | User photo details |
↳ content_url | string | URL to the photo |
↳ file_name | string | Photo file name |
↳ size | number | File size in bytes |
↳ locale | string | Locale (e.g., en-US) |
↳ locale_id | number | Locale ID |
↳ organization_id | number | Primary organization ID |
↳ role | string | User role (end-user, agent, admin) |
↳ role_type | number | Role type identifier |
↳ custom_role_id | number | Custom role ID |
↳ active | boolean | Произошла ли user is active (false if deleted) |
↳ verified | boolean | Whether any user identity has been verified |
↳ alias | string | Alias displayed to end users |
↳ details | string | Details about the user |
↳ notes | string | Notes about the user |
↳ signature | string | User signature for email replies |
↳ default_group_id | number | Default group ID for the user |
↳ tags | array | Tags associated С помощью user |
↳ external_id | string | External ID for linking to external records |
↳ restricted_agent | boolean | Произошла ли agent has restrictions |
↳ suspended | boolean | Произошла ли user is suspended |
↳ moderator | boolean | Произошла ли user has moderator permissions |
↳ chat_only | boolean | Произошла ли user is a chat-only agent |
↳ only_private_comments | boolean | Произошла ли user can only create private comments |
↳ two_factor_auth_enabled | boolean | Whether two-factor auth is enabled |
↳ last_login_at | string | Last login time (ISO 8601 format) |
↳ ticket_restriction | string | Ticket access restriction (organization, groups, assigned, requested) |
↳ user_fields | json | Custom user fields (dynamic key-value pairs) |
↳ shared | boolean | Произошла ли user is shared from a different Zendesk |
↳ shared_agent | boolean | Произошла ли agent is shared from a different Zendesk |
↳ remote_photo_url | string | URL to a remote photo |
user_id | number | The updated user ID |
Обновить multiple users in Zendesk using bulk update
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
users | string | Да | JSON array of user objects to update, each must include id field (e.g., [{"id": "123", "name": "New Name"}]) |
| Параметр | Тип | Описание |
|---|
job_status | object | Job status object for bulk operations |
↳ id | string | Automatically assigned job ID |
↳ url | string | URL to poll for status updates |
↳ status | string | Current job status (queued, working, failed, completed) |
↳ job_type | string | Category of background task |
↳ total | number | Total number of tasks in this job |
↳ progress | number | Number of tasks already completed |
↳ message | string | Message from the job worker |
↳ results | array | Массив result objects from the job |
↳ id | number | ID of the created or updated resource |
↳ index | number | Position of the result in the batch |
↳ action | string | Action performed (e.g., create, update) |
↳ success | boolean | Произошла ли operation succeeded |
↳ status | string | Status message (e.g., Updated, Created) |
↳ error | string | Error message if operation failed |
job_id | string | The bulk operation job ID |
Удалить user from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
userId | string | Да | User ID to delete as a numeric string (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Deletion success |
user_id | string | The deleted user ID |
Получить список of organizations from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain (e.g., "mycompany" for mycompany.zendesk.com) |
perPage | string | Нет | Results per page as a number string (default: "100", max: "100") |
pageAfter | string | Нет | Cursor from a previous response to fetch the next page of results |
| Параметр | Тип | Описание |
|---|
organizations | array | Массив organization objects |
↳ id | number | Automatically assigned organization ID |
↳ url | string | API URL of the organization |
↳ name | string | Unique organization name |
↳ domain_names | array | Domain names for automatic user assignment |
↳ details | string | Details about the organization |
↳ notes | string | Notes about the organization |
↳ group_id | number | Group ID for auto-routing new tickets |
↳ shared_tickets | boolean | Whether end users can see each others tickets |
↳ shared_comments | boolean | Whether end users can see each others comments |
↳ tags | array | Tags associated С помощью organization |
↳ organization_fields | json | Custom organization fields (dynamic key-value pairs) |
↳ created_at | string | When the organization was created (ISO 8601 format) |
↳ updated_at | string | When the organization was last updated (ISO 8601 format) |
↳ external_id | string | External ID for linking to external records |
paging | object | Cursor-based постраничная выборка information |
↳ after_cursor | string | Cursor for fetching the next page of results |
↳ has_more | boolean | Whether more results are available |
↳ next_page | string | URL for next page of results |
metadata | object | Response metadata |
↳ total_returned | number | Number of items returned in this response |
↳ has_more | boolean | Whether more items are available |
Получить a single organization от ID from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
organizationId | string | Да | Organization ID to retrieve as a numeric string (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
organization | object | Organization object |
↳ id | number | Automatically assigned organization ID |
↳ url | string | API URL of the organization |
↳ name | string | Unique organization name |
↳ domain_names | array | Domain names for automatic user assignment |
↳ details | string | Details about the organization |
↳ notes | string | Notes about the organization |
↳ group_id | number | Group ID for auto-routing new tickets |
↳ shared_tickets | boolean | Whether end users can see each others tickets |
↳ shared_comments | boolean | Whether end users can see each others comments |
↳ tags | array | Tags associated С помощью organization |
↳ organization_fields | json | Custom organization fields (dynamic key-value pairs) |
↳ created_at | string | When the organization was created (ISO 8601 format) |
↳ updated_at | string | When the organization was last updated (ISO 8601 format) |
↳ external_id | string | External ID for linking to external records |
organization_id | number | The organization ID |
Autocomplete organizations in Zendesk by name prefix (для name matching/autocomplete)
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
name | string | Да | Organization name prefix to search for (e.g., "Acme") |
perPage | string | Нет | Results per page as a number string (default: "100", max: "100") |
page | string | Нет | Page number for постраничная выборка (1-based) |
| Параметр | Тип | Описание |
|---|
organizations | array | Массив organization objects |
↳ id | number | Automatically assigned organization ID |
↳ url | string | API URL of the organization |
↳ name | string | Unique organization name |
↳ domain_names | array | Domain names for automatic user assignment |
↳ details | string | Details about the organization |
↳ notes | string | Notes about the organization |
↳ group_id | number | Group ID for auto-routing new tickets |
↳ shared_tickets | boolean | Whether end users can see each others tickets |
↳ shared_comments | boolean | Whether end users can see each others comments |
↳ tags | array | Tags associated С помощью organization |
↳ organization_fields | json | Custom organization fields (dynamic key-value pairs) |
↳ created_at | string | When the organization was created (ISO 8601 format) |
↳ updated_at | string | When the organization was last updated (ISO 8601 format) |
↳ external_id | string | External ID for linking to external records |
paging | object | Cursor-based постраничная выборка information |
↳ after_cursor | string | Cursor for fetching the next page of results |
↳ has_more | boolean | Whether more results are available |
↳ next_page | string | URL for next page of results |
metadata | object | Response metadata |
↳ total_returned | number | Number of items returned in this response |
↳ has_more | boolean | Whether more items are available |
Создать новый organization in Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
name | string | Да | Organization name (e.g., "Acme Corporation") |
domainNames | string | Нет | Comma-separated domain names (e.g., "acme.com, acme.org") |
details | string | Нет | Organization details text |
notes | string | Нет | Organization notes text |
tags | string | Нет | Comma-separated tags (e.g., "enterprise, priority") |
customFields | string | Нет | Custom fields as JSON object (e.g., {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
organization | object | Created organization object |
↳ id | number | Automatically assigned organization ID |
↳ url | string | API URL of the organization |
↳ name | string | Unique organization name |
↳ domain_names | array | Domain names for automatic user assignment |
↳ details | string | Details about the organization |
↳ notes | string | Notes about the organization |
↳ group_id | number | Group ID for auto-routing new tickets |
↳ shared_tickets | boolean | Whether end users can see each others tickets |
↳ shared_comments | boolean | Whether end users can see each others comments |
↳ tags | array | Tags associated С помощью organization |
↳ organization_fields | json | Custom organization fields (dynamic key-value pairs) |
↳ created_at | string | When the organization was created (ISO 8601 format) |
↳ updated_at | string | When the organization was last updated (ISO 8601 format) |
↳ external_id | string | External ID for linking to external records |
organization_id | number | The created organization ID |
Создать multiple organizations in Zendesk using bulk import
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
organizations | string | Да | JSON array of organization objects to create (e.g., [{"name": "Org1"}, {"name": "Org2"}]) |
| Параметр | Тип | Описание |
|---|
job_status | object | Job status object for bulk operations |
↳ id | string | Automatically assigned job ID |
↳ url | string | URL to poll for status updates |
↳ status | string | Current job status (queued, working, failed, completed) |
↳ job_type | string | Category of background task |
↳ total | number | Total number of tasks in this job |
↳ progress | number | Number of tasks already completed |
↳ message | string | Message from the job worker |
↳ results | array | Массив result objects from the job |
↳ id | number | ID of the created or updated resource |
↳ index | number | Position of the result in the batch |
↳ action | string | Action performed (e.g., create, update) |
↳ success | boolean | Произошла ли operation succeeded |
↳ status | string | Status message (e.g., Updated, Created) |
↳ error | string | Error message if operation failed |
job_id | string | The bulk operation job ID |
Обновитьn existing organization in Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
organizationId | string | Да | Organization ID to update as a numeric string (e.g., "12345") |
name | string | Нет | New organization name (e.g., "Acme Corporation") |
domainNames | string | Нет | Comma-separated domain names (e.g., "acme.com, acme.org") |
details | string | Нет | Organization details text |
notes | string | Нет | Organization notes text |
tags | string | Нет | Comma-separated tags (e.g., "enterprise, priority") |
customFields | string | Нет | Custom fields as JSON object (e.g., {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
organization | object | Updated organization object |
↳ id | number | Automatically assigned organization ID |
↳ url | string | API URL of the organization |
↳ name | string | Unique organization name |
↳ domain_names | array | Domain names for automatic user assignment |
↳ details | string | Details about the organization |
↳ notes | string | Notes about the organization |
↳ group_id | number | Group ID for auto-routing new tickets |
↳ shared_tickets | boolean | Whether end users can see each others tickets |
↳ shared_comments | boolean | Whether end users can see each others comments |
↳ tags | array | Tags associated С помощью organization |
↳ organization_fields | json | Custom organization fields (dynamic key-value pairs) |
↳ created_at | string | When the organization was created (ISO 8601 format) |
↳ updated_at | string | When the organization was last updated (ISO 8601 format) |
↳ external_id | string | External ID for linking to external records |
organization_id | number | The updated organization ID |
Удалитьn organization from Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
organizationId | string | Да | Organization ID to delete as a numeric string (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли organization was successfully deleted |
organization_id | string | The deleted organization ID |
Unified search across tickets, users, и organizations in Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
query | string | Да | Search query string using Zendesk search syntax (e.g., "type:ticket status:open") |
filterType | string | Да | Resource type to search for: "ticket", "user", "organization", or "group" |
perPage | string | Нет | Results per page as a number string (default: "100", max: "100") |
pageAfter | string | Нет | Cursor from a previous response to fetch the next page of results |
| Параметр | Тип | Описание |
|---|
paging | object | Cursor-based постраничная выборка information |
↳ after_cursor | string | Cursor for fetching the next page of results |
↳ has_more | boolean | Whether more results are available |
↳ next_page | string | URL for next page of results |
metadata | object | Response metadata |
↳ total_returned | number | Number of items returned in this response |
↳ has_more | boolean | Whether more items are available |
results | array | Массив result objects (tickets, users, or organizations depending on search query) |
Count the number of search results matching a запрос in Zendesk
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Your Zendesk email address |
apiToken | string | Да | Zendesk API token |
subdomain | string | Да | Your Zendesk subdomain |
query | string | Да | Search query string using Zendesk search syntax (e.g., "type:ticket status:open") |
| Параметр | Тип | Описание |
|---|
count | number | Number of matching results |
