Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://{subdomain}.{domain}.com
/api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}
Updates individual custom object fields. The updating rules are as follows:
custom_object_field object that specifies the properties to updatekey property cannot be updatedtitle and description properties can be updated.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| custom_object_key | path | optional | string | The key of a custom object |
| custom_object_field_key_or_id | path | optional | string | The key or id of a custom object field |
Success response
PATCH /api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}
/api/v2/custom_objects/{custom_object_key}/records
If a record exists for the given external id, updates it. Only the specified attributes are updated. Otherwise, creates a new record with the provided external id and attributes.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| custom_object_key | path | optional | string | The key of a custom object |
| external_id | query | optional | string | The external id of a custom object record |
application/json
CustomObjectRecordsUpsertRequest
| Property | Type | Required |
|---|---|---|
| custom_object_record | object | optional |
| └ id | string | optional |
| └ url | string | optional |
| └ name | string | required |
| └ created_at | string | optional |
| └ updated_at | string | optional |
| └ external_id | string | optional |
| └ custom_object_key | string | optional |
| └ created_by_user_id | string | optional |
| └ updated_by_user_id | string | optional |
| └ custom_object_fields | object | optional |
Success
PATCH /api/v2/custom_objects/{custom_object_key}/records
/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}
Updates an individual custom object record. The updating rules are as follows:
custom_object_record object that specifies the properties to updatecustom_object_fields object
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| custom_object_key | path | optional | string | The key of a custom object |
| custom_object_record_id | path | optional | string | The id of a custom object record |
Success response
PATCH /api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}
/api/v2/custom_objects/{custom_object_key}
Updates an individual custom object. The updating rules are as follows:
custom_object object that specifies the properties to updatekey property cannot be updated
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| custom_object_key | path | optional | string | The key of a custom object |
Success response
PATCH /api/v2/custom_objects/{custom_object_key}
/api/v2/routing/attributes/{attribute_id}/values/{attribute_value_id}
Updates an attribute value.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| attribute_id | path | optional | string | The ID of the skill-based routing attribute |
| attribute_value_id | path | optional | string | The ID of the skill-based routing attribute value |
Success response
PATCH /api/v2/routing/attributes/{attribute_id}/values/{attribute_value_id}
/api/v2/trigger_categories/{trigger_category_id}
Updates the trigger category with the specified ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| trigger_category_id | path | required | string | The id of the trigger category to update |
application/json
TriggerCategoriesUpdateCategoryByIdRequest
| Property | Type | Required |
|---|---|---|
| trigger_category | object | optional |
| └ name | string | optional |
| └ position | integer | optional |
The updated trigger category
Error
Error
PATCH /api/v2/trigger_categories/{trigger_category_id}
AccountSettingsActiveFeaturesObject
{
"type": "object",
"properties": {
"chat": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"explore": {
"type": "boolean"
},
"sandbox": {
"type": "boolean"
},
"twitter": {
"type": "boolean"
},
"facebook": {
"type": "boolean"
},
"insights": {
"type": "boolean"
},
"markdown": {
"type": "boolean"
},
"allow_ccs": {
"type": "boolean"
},
"is_abusive": {
"type": "boolean"
},
"google_login": {
"type": "boolean"
},
"light_agents": {
"type": "boolean"
},
"ticket_forms": {
"type": "boolean"
},
"user_tagging": {
"type": "boolean"
},
"bcc_archiving": {
"type": "boolean"
},
"twitter_login": {
"type": "boolean"
},
"business_hours": {
"type": "boolean"
},
"facebook_login": {
"type": "boolean"
},
"on_hold_status": {
"type": "boolean"
},
"ticket_tagging": {
"type": "boolean"
},
"forum_analytics": {
"type": "boolean"
},
"user_org_fields": {
"type": "boolean"
},
"agent_forwarding": {
"type": "boolean"
},
"csat_reason_code": {
"type": "boolean"
},
"dynamic_contents": {
"type": "boolean"
},
"topic_suggestion": {
"type": "boolean"
},
"automatic_answers": {
"type": "boolean"
},
"benchmark_opt_out": {
"type": "boolean"
},
"fallback_composer": {
"type": "boolean"
},
"advanced_analytics": {
"type": "boolean"
},
"custom_dkim_domain": {
"type": "boolean"
},
"chat_about_my_ticket": {
"type": "boolean"
},
"customer_satisfaction": {
"type": "boolean"
},
"good_data_and_explore": {
"type": "boolean"
},
"rich_content_in_emails": {
"type": "boolean"
},
"satisfaction_prediction": {
"type": "boolean"
},
"customer_context_as_default": {
"type": "boolean"
},
"explore_on_support_ent_plan": {
"type": "boolean"
},
"explore_on_support_pro_plan": {
"type": "boolean"
},
"organization_access_enabled": {
"type": "boolean"
},
"suspended_ticket_notification": {
"type": "boolean"
},
"allow_email_template_customization": {
"type": "boolean"
}
},
"description": "The active features for an account. See [Active Features](https://developer.zendesk.com)"
}
AccountSettingsAgentObject
{
"type": "object",
"properties": {
"agent_home": {
"type": "boolean"
},
"focus_mode": {
"type": "boolean"
},
"agent_workspace": {
"type": "boolean"
},
"idle_timeout_enabled": {
"type": "boolean"
},
"unified_agent_statuses": {
"type": "boolean"
},
"aw_self_serve_migration_enabled": {
"type": "boolean"
}
},
"description": "Configuration for the agent workspace. See [Agents](https://developer.zendesk.com)"
}
AccountSettingsApiObject
{
"type": "object",
"properties": {
"api_token_access": {
"type": "string"
},
"api_password_access": {
"type": "string"
},
"accepted_api_agreement": {
"type": "boolean"
}
},
"description": "API configuration options. See [API](https://developer.zendesk.com)"
}
AccountSettingsAppsObject
{
"type": "object",
"properties": {
"use": {
"type": "boolean"
},
"create_public": {
"type": "boolean"
},
"create_private": {
"type": "boolean"
}
},
"description": "Apps configuration options. See [Apps](https://developer.zendesk.com)"
}
AccountSettingsBillingObject
{
"type": "object",
"properties": {
"backend": {
"type": "string"
}
},
"description": "Billing configuration options. See [Billing](https://developer.zendesk.com)"
}
AccountSettingsBrandingObject
{
"type": "object",
"properties": {
"text_color": {
"type": "string"
},
"favicon_url": {
"type": "string",
"nullable": true
},
"header_color": {
"type": "string"
},
"header_logo_url": {
"type": "string",
"nullable": true
},
"tab_background_color": {
"type": "string"
},
"page_background_color": {
"type": "string"
}
},
"description": "Branding settings. See [Branding](https://developer.zendesk.com)"
}
AccountSettingsBrandsObject
{
"type": "object",
"properties": {
"default_brand_id": {
"type": "integer"
},
"require_brand_on_new_tickets": {
"type": "boolean"
}
},
"description": "Brand settings. See [Brands](https://developer.zendesk.com)"
}
AccountSettingsCdnObject
{
"type": "object",
"properties": {
"hosts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"cdn_provider": {
"type": "string"
},
"fallback_cdn_provider": {
"type": "string"
}
},
"description": "CDN settings"
}
AccountSettingsChatObject
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"available": {
"type": "boolean"
},
"integrated": {
"type": "boolean"
},
"welcome_message": {
"type": "string"
},
"maximum_request_count": {
"type": "integer"
}
},
"description": "Zendesk Chat settings. See [Chat](https://developer.zendesk.com)"
}
AccountSettingsCrossSellObject
{
"type": "object",
"properties": {
"xsell_source": {
"type": "string",
"nullable": true
},
"show_chat_tooltip": {
"type": "boolean"
}
},
"description": "Cross Sell settings"
}
AccountSettingsGooddataAdvancedAnalyticsObject
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"description": "GoodData settings, used for insights. Legacy configuration prior to Zendesk Explore. See [GoodData Advanced Analytics](https://developer.zendesk.com)"
}
AccountSettingsGoogleAppsObject
{
"type": "object",
"properties": {
"has_google_apps": {
"type": "boolean"
},
"has_google_apps_admin": {
"type": "boolean"
}
},
"description": "Google Apps configuration. See [G Suite](https://developer.zendesk.com)"
}
AccountSettingsGroupObject
{
"type": "object",
"properties": {
"check_group_name_uniqueness": {
"type": "boolean"
}
},
"description": "Group configuration"
}
AccountSettingsLimitsObject
{
"type": "object",
"properties": {
"attachment_size": {
"type": "integer"
}
},
"description": "Account limits configuration. See [Limits](https://developer.zendesk.com)"
}
AccountSettingsLocalizationObject
{
"type": "object",
"properties": {
"locale_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "Internationalization configuration settings. See [Localization](https://developer.zendesk.com)"
}
AccountSettingsLotusObject
{
"type": "object",
"properties": {
"pod_id": {
"type": "integer"
},
"reporting": {
"type": "boolean"
},
"prefer_lotus": {
"type": "boolean"
}
},
"description": "Support UI settings. See [Lotus](https://developer.zendesk.com)"
}
AccountSettingsMetricsObject
{
"type": "object",
"properties": {
"account_size": {
"type": "string"
}
},
"description": "Account metrics settings. See [Metrics](https://developer.zendesk.com)"
}
AccountSettingsObject
{
"type": "object",
"example": {
"api": {
"api_token_access": "true",
"api_password_access": "true",
"accepted_api_agreement": true
},
"cdn": {
"hosts": [
{
"url": "https://p18.zdassets.com",
"name": "default"
},
{
"url": "https://d2y9oszrd3dhjh.cloudfront.net",
"name": "cloudfront"
}
],
"cdn_provider": "default",
"fallback_cdn_provider": "cloudfront"
},
"apps": {
"use": true,
"create_public": false,
"create_private": true
},
"chat": {
"enabled": false,
"available": true,
"integrated": true,
"welcome_message": "Hi there. How can I help today?",
"maximum_request_count": 1
},
"rule": {
"macro_order": "alphabetical",
"macro_most_used": true,
"using_skill_based_routing": false,
"skill_based_filtered_views": []
},
"user": {
"tagging": true,
"language_selection": true,
"time_zone_selection": true,
"have_gravatars_enabled": true,
"multiple_organizations": false,
"agent_created_welcome_emails": true,
"end_user_phone_number_validation": false
},
"lotus": {
"pod_id": 999,
"reporting": true,
"prefer_lotus": true
},
"voice": {
"enabled": true,
"logging": true,
"outbound_enabled": true,
"recordings_public": true,
"maximum_queue_size": 5,
"uk_mobile_forwarding": true,
"maximum_queue_wait_time": 1,
"agent_wrap_up_after_calls": true,
"only_during_business_hours": false,
"agent_confirmation_when_forwarding": true
},
"agents": {
"agent_home": false,
"focus_mode": false,
"agent_workspace": false,
"idle_timeout_enabled": false,
"unified_agent_statuses": false,
"aw_self_serve_migration_enabled": true
},
"brands": {
"default_brand_id": 1873,
"require_brand_on_new_tickets": false
},
"groups": {
"check_group_name_uniqueness": true
},
"limits": {
"attachment_size": 52428800
},
"billing": {
"backend": "zuora"
},
"metrics": {
"account_size": "100-399"
},
"routing": {
"enabled": false,
"autorouting_tag": "",
"max_email_capacity": 0,
"max_messaging_capacity": 0,
"reassignment_talk_timeout": 30,
"reassignment_messaging_enabled": true,
"reassignment_messaging_timeout": 30
},
"tickets": {
"tagging": true,
"status_hold": false,
"collaboration": true,
"has_color_text": true,
"agent_collision": true,
"list_empty_views": true,
"allow_group_reset": true,
"email_attachments": false,
"rich_text_comments": true,
"chat_sla_enablement": false,
"private_attachments": false,
"emoji_autocompletion": true,
"agent_ticket_deletion": false,
"agent_invitation_enabled": true,
"auto_translation_enabled": false,
"markdown_ticket_comments": false,
"assign_tickets_upon_solve": true,
"using_skill_based_routing": false,
"comments_public_by_default": true,
"list_newest_comments_first": true,
"assign_default_organization": true,
"light_agent_email_ccs_allowed": false,
"accepted_new_collaboration_tos": false,
"maximum_personal_views_to_list": 8,
"auto_updated_ccs_followers_rules": false,
"is_first_comment_private_enabled": true,
"follower_and_email_cc_collaborations": false
},
"twitter": {
"shorten_url": "optional"
},
"branding": {
"text_color": "FFFFFF",
"favicon_url": null,
"header_color": "78A300",
"header_logo_url": null,
"tab_background_color": "7FA239",
"page_background_color": "333333"
},
"cross_sell": {
"xsell_source": null,
"show_chat_tooltip": true
},
"onboarding": {
"product_sign_up": null,
"onboarding_segments": null,
"checklist_onboarding_version": 2
},
"statistics": {
"forum": true,
"search": true,
"rule_usage": true
},
"google_apps": {
"has_google_apps": false,
"has_google_apps_admin": false
},
"ticket_form": {
"ticket_forms_instructions": "Please choose your issue below",
"raw_ticket_forms_instructions": "Please choose your issue below"
},
"localization": {
"locale_ids": [
1042
]
},
"active_features": {
"chat": false,
"voice": true,
"explore": true,
"sandbox": false,
"twitter": true,
"facebook": false,
"insights": false,
"markdown": false,
"allow_ccs": true,
"is_abusive": false,
"google_login": false,
"light_agents": false,
"ticket_forms": true,
"user_tagging": true,
"bcc_archiving": false,
"twitter_login": false,
"business_hours": false,
"facebook_login": false,
"on_hold_status": false,
"ticket_tagging": true,
"forum_analytics": true,
"user_org_fields": true,
"agent_forwarding": false,
"csat_reason_code": false,
"dynamic_contents": false,
"topic_suggestion": false,
"automatic_answers": false,
"benchmark_opt_out": false,
"fallback_composer": false,
"advanced_analytics": false,
"custom_dkim_domain": true,
"chat_about_my_ticket": false,
"customer_satisfaction": false,
"good_data_and_explore": false,
"rich_content_in_emails": true,
"satisfaction_prediction": false,
"customer_context_as_default": false,
"explore_on_support_ent_plan": false,
"explore_on_support_pro_plan": false,
"organization_access_enabled": true,
"suspended_ticket_notification": false,
"allow_email_template_customization": true
},
"side_conversations": {
"email_channel": false,
"slack_channel": false,
"msteams_channel": false,
"tickets_channel": false,
"show_in_context_panel": false
},
"ticket_sharing_partners": {
"support_addresses": [
"support@grokpetre.zendesk.com"
]
},
"gooddata_advanced_analytics": {
"enabled": true
}
},
"properties": {
"api": {
"$ref": "#/components/schemas/AccountSettingsApiObject"
},
"cdn": {
"$ref": "#/components/schemas/AccountSettingsCdnObject"
},
"apps": {
"$ref": "#/components/schemas/AccountSettingsAppsObject"
},
"chat": {
"$ref": "#/components/schemas/AccountSettingsChatObject"
},
"rule": {
"$ref": "#/components/schemas/AccountSettingsRuleObject"
},
"user": {
"$ref": "#/components/schemas/AccountSettingsUserObject"
},
"lotus": {
"$ref": "#/components/schemas/AccountSettingsLotusObject"
},
"voice": {
"$ref": "#/components/schemas/AccountSettingsVoiceObject"
},
"agents": {
"$ref": "#/components/schemas/AccountSettingsAgentObject"
},
"brands": {
"$ref": "#/components/schemas/AccountSettingsBrandsObject"
},
"groups": {
"$ref": "#/components/schemas/AccountSettingsGroupObject"
},
"limits": {
"$ref": "#/components/schemas/AccountSettingsLimitsObject"
},
"billing": {
"$ref": "#/components/schemas/AccountSettingsBillingObject"
},
"metrics": {
"$ref": "#/components/schemas/AccountSettingsMetricsObject"
},
"routing": {
"$ref": "#/components/schemas/AccountSettingsRoutingObject"
},
"tickets": {
"$ref": "#/components/schemas/AccountSettingsTicketObject"
},
"twitter": {
"$ref": "#/components/schemas/AccountSettingsTwitterObject"
},
"branding": {
"$ref": "#/components/schemas/AccountSettingsBrandingObject"
},
"cross_sell": {
"$ref": "#/components/schemas/AccountSettingsCrossSellObject"
},
"onboarding": {
"$ref": "#/components/schemas/AccountSettingsOnboardingObject"
},
"statistics": {
"$ref": "#/components/schemas/AccountSettingsStatisticsObject"
},
"google_apps": {
"$ref": "#/components/schemas/AccountSettingsGoogleAppsObject"
},
"ticket_form": {
"$ref": "#/components/schemas/AccountSettingsTicketFormObject"
},
"localization": {
"$ref": "#/components/schemas/AccountSettingsLocalizationObject"
},
"active_features": {
"$ref": "#/components/schemas/AccountSettingsActiveFeaturesObject"
},
"side_conversations": {
"$ref": "#/components/schemas/AccountSettingsSideConversationsObject"
},
"ticket_sharing_partners": {
"$ref": "#/components/schemas/AccountSettingsTicketSharingPartnersObject"
},
"gooddata_advanced_analytics": {
"$ref": "#/components/schemas/AccountSettingsGooddataAdvancedAnalyticsObject"
}
}
}
AccountSettingsOnboardingObject
{
"type": "object",
"properties": {
"product_sign_up": {
"type": "string",
"nullable": true
},
"onboarding_segments": {
"type": "string",
"nullable": true
},
"checklist_onboarding_version": {
"type": "integer"
}
},
"description": "Onboarding settings"
}
AccountSettingsResponse
{
"type": "object",
"example": {
"settings": {
"api": {
"api_token_access": "true",
"api_password_access": "true",
"accepted_api_agreement": true
},
"cdn": {
"hosts": [
{
"url": "https://p18.zdassets.com",
"name": "default"
},
{
"url": "https://d2y9oszrd3dhjh.cloudfront.net",
"name": "cloudfront"
}
],
"cdn_provider": "default",
"fallback_cdn_provider": "cloudfront"
},
"apps": {
"use": true,
"create_public": false,
"create_private": true
},
"chat": {
"enabled": false,
"available": true,
"integrated": true,
"welcome_message": "Hi there. How can I help today?",
"maximum_request_count": 1
},
"rule": {
"macro_order": "alphabetical",
"macro_most_used": true,
"using_skill_based_routing": false,
"skill_based_filtered_views": []
},
"user": {
"tagging": true,
"language_selection": true,
"time_zone_selection": true,
"have_gravatars_enabled": true,
"multiple_organizations": false,
"agent_created_welcome_emails": true,
"end_user_phone_number_validation": false
},
"lotus": {
"pod_id": 999,
"reporting": true,
"prefer_lotus": true
},
"voice": {
"enabled": true,
"logging": true,
"outbound_enabled": true,
"recordings_public": true,
"maximum_queue_size": 5,
"uk_mobile_forwarding": true,
"maximum_queue_wait_time": 1,
"agent_wrap_up_after_calls": true,
"only_during_business_hours": false,
"agent_confirmation_when_forwarding": true
},
"agents": {
"agent_home": false,
"focus_mode": false,
"agent_workspace": false,
"idle_timeout_enabled": false,
"unified_agent_statuses": false,
"aw_self_serve_migration_enabled": true
},
"brands": {
"default_brand_id": 1873,
"require_brand_on_new_tickets": false
},
"groups": {
"check_group_name_uniqueness": true
},
"limits": {
"attachment_size": 52428800
},
"billing": {
"backend": "zuora"
},
"metrics": {
"account_size": "100-399"
},
"routing": {
"enabled": false,
"autorouting_tag": "",
"max_email_capacity": 0,
"max_messaging_capacity": 0
},
"tickets": {
"tagging": true,
"status_hold": false,
"collaboration": true,
"has_color_text": true,
"agent_collision": true,
"list_empty_views": true,
"allow_group_reset": true,
"email_attachments": false,
"rich_text_comments": true,
"chat_sla_enablement": false,
"private_attachments": false,
"emoji_autocompletion": true,
"agent_ticket_deletion": false,
"agent_invitation_enabled": true,
"auto_translation_enabled": false,
"markdown_ticket_comments": false,
"assign_tickets_upon_solve": true,
"using_skill_based_routing": false,
"comments_public_by_default": true,
"list_newest_comments_first": true,
"assign_default_organization": true,
"light_agent_email_ccs_allowed": false,
"accepted_new_collaboration_tos": false,
"maximum_personal_views_to_list": 8,
"auto_updated_ccs_followers_rules": false,
"is_first_comment_private_enabled": true,
"follower_and_email_cc_collaborations": false
},
"twitter": {
"shorten_url": "optional"
},
"branding": {
"text_color": "FFFFFF",
"favicon_url": null,
"header_color": "78A300",
"header_logo_url": null,
"tab_background_color": "7FA239",
"page_background_color": "333333"
},
"cross_sell": {
"xsell_source": null,
"show_chat_tooltip": true
},
"onboarding": {
"product_sign_up": null,
"onboarding_segments": null,
"checklist_onboarding_version": 2
},
"statistics": {
"forum": true,
"search": true,
"rule_usage": true
},
"google_apps": {
"has_google_apps": false,
"has_google_apps_admin": false
},
"ticket_form": {
"ticket_forms_instructions": "Please choose your issue below",
"raw_ticket_forms_instructions": "Please choose your issue below"
},
"localization": {
"locale_ids": [
1042
]
},
"active_features": {
"chat": false,
"voice": true,
"explore": true,
"sandbox": false,
"twitter": true,
"facebook": false,
"insights": false,
"markdown": false,
"allow_ccs": true,
"is_abusive": false,
"google_login": false,
"light_agents": false,
"ticket_forms": true,
"user_tagging": true,
"bcc_archiving": false,
"twitter_login": false,
"business_hours": false,
"facebook_login": false,
"on_hold_status": false,
"ticket_tagging": true,
"forum_analytics": true,
"user_org_fields": true,
"agent_forwarding": false,
"csat_reason_code": false,
"dynamic_contents": false,
"topic_suggestion": false,
"automatic_answers": false,
"benchmark_opt_out": false,
"fallback_composer": false,
"advanced_analytics": false,
"custom_dkim_domain": true,
"chat_about_my_ticket": false,
"customer_satisfaction": false,
"good_data_and_explore": false,
"rich_content_in_emails": true,
"satisfaction_prediction": false,
"customer_context_as_default": false,
"explore_on_support_ent_plan": false,
"explore_on_support_pro_plan": false,
"organization_access_enabled": true,
"suspended_ticket_notification": false,
"allow_email_template_customization": true
},
"side_conversations": {
"email_channel": false,
"slack_channel": false,
"msteams_channel": false,
"tickets_channel": false,
"show_in_context_panel": false
},
"ticket_sharing_partners": {
"support_addresses": [
"support@grokpetre.zendesk.com"
]
},
"gooddata_advanced_analytics": {
"enabled": true
}
}
},
"properties": {
"settings": {
"$ref": "#/components/schemas/AccountSettingsObject"
}
}
}
AccountSettingsRoutingObject
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"autorouting_tag": {
"type": "string"
},
"max_email_capacity": {
"type": "integer"
},
"max_messaging_capacity": {
"type": "integer"
},
"reassignment_talk_timeout": {
"type": "integer"
},
"reassignment_messaging_enabled": {
"type": "boolean"
},
"reassignment_messaging_timeout": {
"type": "integer"
}
},
"description": "Configuration for routing. See [Routing](https://developer.zendesk.com)"
}
AccountSettingsRuleObject
{
"type": "object",
"properties": {
"macro_order": {
"type": "string"
},
"macro_most_used": {
"type": "boolean"
},
"using_skill_based_routing": {
"type": "boolean"
},
"skill_based_filtered_views": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"description": "Rules settings for triggers, macros, views, and automations. See [Rules](https://developer.zendesk.com)"
}
AccountSettingsSideConversationsObject
{
"type": "object",
"properties": {
"email_channel": {
"type": "boolean"
},
"slack_channel": {
"type": "boolean"
},
"msteams_channel": {
"type": "boolean"
},
"tickets_channel": {
"type": "boolean"
},
"show_in_context_panel": {
"type": "boolean"
}
},
"description": "Side conversations settings"
}
AccountSettingsStatisticsObject
{
"type": "object",
"properties": {
"forum": {
"type": "boolean"
},
"search": {
"type": "boolean"
},
"rule_usage": {
"type": "boolean"
}
},
"description": "Account statistics settings. See [Statistics](https://developer.zendesk.com)"
}
AccountSettingsTicketFormObject
{
"type": "object",
"properties": {
"ticket_forms_instructions": {
"type": "string"
},
"raw_ticket_forms_instructions": {
"type": "string"
}
},
"description": "Ticket form settings. See [Ticket Form](https://developer.zendesk.com)"
}
AccountSettingsTicketObject
{
"type": "object",
"properties": {
"tagging": {
"type": "boolean"
},
"status_hold": {
"type": "boolean"
},
"collaboration": {
"type": "boolean"
},
"has_color_text": {
"type": "boolean"
},
"agent_collision": {
"type": "boolean"
},
"list_empty_views": {
"type": "boolean"
},
"allow_group_reset": {
"type": "boolean"
},
"email_attachments": {
"type": "boolean"
},
"rich_text_comments": {
"type": "boolean"
},
"chat_sla_enablement": {
"type": "boolean"
},
"private_attachments": {
"type": "boolean"
},
"emoji_autocompletion": {
"type": "boolean"
},
"agent_ticket_deletion": {
"type": "boolean"
},
"agent_invitation_enabled": {
"type": "boolean"
},
"auto_translation_enabled": {
"type": "boolean"
},
"markdown_ticket_comments": {
"type": "boolean"
},
"assign_tickets_upon_solve": {
"type": "boolean"
},
"using_skill_based_routing": {
"type": "boolean"
},
"comments_public_by_default": {
"type": "boolean"
},
"list_newest_comments_first": {
"type": "boolean"
},
"assign_default_organization": {
"type": "boolean"
},
"light_agent_email_ccs_allowed": {
"type": "boolean"
},
"accepted_new_collaboration_tos": {
"type": "boolean"
},
"maximum_personal_views_to_list": {
"type": "integer"
},
"auto_updated_ccs_followers_rules": {
"type": "boolean"
},
"is_first_comment_private_enabled": {
"type": "boolean"
},
"follower_and_email_cc_collaborations": {
"type": "boolean"
}
},
"description": "Ticket settings. See [Tickets](https://developer.zendesk.com)"
}
AccountSettingsTicketSharingPartnersObject
{
"type": "object",
"properties": {
"support_addresses": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Ticket sharing partners settings. See [Ticket Sharing Partners](https://developer.zendesk.com)"
}
AccountSettingsTwitterObject
{
"type": "object",
"properties": {
"shorten_url": {
"type": "string"
}
},
"description": "X (formerly Twitter) settings. See [X](https://developer.zendesk.com)"
}
AccountSettingsUserObject
{
"type": "object",
"properties": {
"tagging": {
"type": "boolean"
},
"language_selection": {
"type": "boolean"
},
"time_zone_selection": {
"type": "boolean"
},
"have_gravatars_enabled": {
"type": "boolean"
},
"multiple_organizations": {
"type": "boolean"
},
"agent_created_welcome_emails": {
"type": "boolean"
},
"end_user_phone_number_validation": {
"type": "boolean"
}
},
"description": "User settings. See [Users](https://developer.zendesk.com)"
}
AccountSettingsVoiceObject
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"logging": {
"type": "boolean"
},
"outbound_enabled": {
"type": "boolean"
},
"recordings_public": {
"type": "boolean"
},
"maximum_queue_size": {
"type": "integer"
},
"uk_mobile_forwarding": {
"type": "boolean"
},
"maximum_queue_wait_time": {
"type": "integer"
},
"agent_wrap_up_after_calls": {
"type": "boolean"
},
"only_during_business_hours": {
"type": "boolean"
},
"agent_confirmation_when_forwarding": {
"type": "boolean"
}
},
"description": "Zendesk Talk settings. See [Voice](https://developer.zendesk.com)"
}
ActionObject
{
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The name of a ticket field to modify"
},
"value": {
"type": "string",
"description": "The new value of the field"
}
}
}
ActionsObject
{
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionObject"
}
}
}
}
ActivitiesCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {
"type": "integer"
},
"refreshed_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
ActivitiesResponse
{
"type": "object",
"example": {
"count": 1,
"users": [
{
"id": 3343,
"url": "https://example.zendesk.com/api/v2/users/3343.json",
"name": "Samwise Gamgee",
"role": "admin",
"tags": [
"101"
],
"alias": "test",
"email": "user@zendesk.com",
"notes": "test",
"phone": null,
"photo": {
"id": 8730791,
"url": "https://example.zendesk.com/api/v2/attachments/8730791.json",
"size": 4566,
"width": 80,
"height": 80,
"inline": false,
"deleted": false,
"file_name": "1f84950b8d7949b3.gif",
"thumbnails": [
{
"id": 8730801,
"url": "https://example.zendesk.com/api/v2/attachments/8730801.json",
"size": 1517,
"width": 32,
"height": 32,
"inline": false,
"deleted": false,
"file_name": "1f84950b8d7949b3_thumb.gif",
"content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
"content_type": "image/gif",
"mapped_content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif"
}
],
"content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
"content_type": "image/gif",
"mapped_content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif"
},
"active": true,
"locale": "en-gb",
"shared": false,
"details": "",
"verified": true,
"locale_id": 5,
"moderator": true,
"role_type": null,
"signature": "test",
"suspended": false,
"time_zone": "American Samoa",
"created_at": "2017-08-14T20:13:53Z",
"report_csv": true,
"updated_at": "2020-11-17T00:33:55Z",
"external_id": "oev7jj",
"user_fields": {
"skittles": "2018-09-14T00:00:00+00:00",
"user_field_1": "101",
"its_remember_september": null
},
"shared_agent": false,
"last_login_at": "2020-11-16T22:57:45Z",
"custom_role_id": null,
"iana_time_zone": "Pacific/Pago_Pago",
"organization_id": 1873,
"default_group_id": 1873,
"restricted_agent": false,
"ticket_restriction": null,
"shared_phone_number": null,
"only_private_comments": false,
"two_factor_auth_enabled": null
}
],
"actors": [
{
"id": 158488612,
"url": "https://example.zendesk.com/api/v2/users/158488612.json",
"name": "Tedd",
"role": "admin",
"tags": [],
"alias": "",
"email": "cgoddard+ted@zendesk.com",
"notes": "",
"phone": null,
"photo": null,
"active": true,
"locale": "en-gb",
"shared": false,
"details": "",
"verified": true,
"locale_id": 5,
"moderator": true,
"role_type": null,
"signature": "",
"suspended": false,
"time_zone": "Alaska",
"created_at": "2020-11-17T00:32:12Z",
"report_csv": true,
"updated_at": "2020-11-17T00:34:38Z",
"external_id": null,
"user_fields": {
"skittles": null,
"user_field_1": null,
"its_remember_september": null
},
"shared_agent": false,
"last_login_at": "2020-11-17T00:33:44Z",
"custom_role_id": null,
"iana_time_zone": "America/Juneau",
"organization_id": null,
"default_group_id": 1873,
"restricted_agent": false,
"ticket_restriction": null,
"shared_phone_number": null,
"only_private_comments": false,
"two_factor_auth_enabled": null
}
],
"next_page": null,
"activities": [
{
"id": 29183462,
"url": "https://example.zendesk.com/api/v2/activities/29183462.json",
"user": {
"id": 3343,
"url": "https://example.zendesk.com/api/v2/users/3343.json",
"name": "Samwise Gamgee",
"role": "admin",
"tags": [
"101"
],
"alias": "test",
"email": "user@zendesk.com",
"notes": "test",
"phone": null,
"photo": {
"id": 8730791,
"url": "https://example.zendesk.com/api/v2/attachments/8730791.json",
"size": 4566,
"width": 80,
"height": 80,
"inline": false,
"deleted": false,
"file_name": "1f84950b8d7949b3.gif",
"thumbnails": [
{
"id": 8730801,
"url": "https://example.zendesk.com/api/v2/attachments/8730801.json",
"size": 1517,
"width": 32,
"height": 32,
"inline": false,
"deleted": false,
"file_name": "1f84950b8d7949b3_thumb.gif",
"content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
"content_type": "image/gif",
"mapped_content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif"
}
],
"content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
"content_type": "image/gif",
"mapped_content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif"
},
"active": true,
"locale": "en-gb",
"shared": false,
"details": "",
"verified": true,
"locale_id": 5,
"moderator": true,
"role_type": null,
"signature": "test",
"suspended": false,
"time_zone": "American Samoa",
"created_at": "2017-08-14T20:13:53Z",
"report_csv": true,
"updated_at": "2020-11-17T00:33:55Z",
"external_id": "oev7jj",
"user_fields": {
"skittles": "2018-09-14T00:00:00+00:00",
"user_field_1": "101",
"its_remember_september": null
},
"shared_agent": false,
"last_login_at": "2020-11-16T22:57:45Z",
"custom_role_id": null,
"iana_time_zone": "Pacific/Pago_Pago",
"organization_id": 1873,
"default_group_id": 1873,
"restricted_agent": false,
"ticket_restriction": null,
"shared_phone_number": null,
"only_private_comments": false,
"two_factor_auth_enabled": null
},
"verb": "tickets.assignment",
"actor": {
"id": 158488612,
"url": "https://example.zendesk.com/api/v2/users/158488612.json",
"name": "Tedd",
"role": "admin",
"tags": [],
"alias": "",
"email": "cgoddard+ted@zendesk.com",
"notes": "",
"phone": null,
"photo": null,
"active": true,
"locale": "en-gb",
"shared": false,
"details": "",
"verified": true,
"locale_id": 5,
"moderator": true,
"role_type": null,
"signature": "",
"suspended": false,
"time_zone": "Alaska",
"created_at": "2020-11-17T00:32:12Z",
"report_csv": true,
"updated_at": "2020-11-17T00:34:38Z",
"external_id": null,
"user_fields": {
"skittles": null,
"user_field_1": null,
"its_remember_september": null
},
"shared_agent": false,
"last_login_at": "2020-11-17T00:33:44Z",
"custom_role_id": null,
"iana_time_zone": "America/Juneau",
"organization_id": null,
"default_group_id": 1873,
"restricted_agent": false,
"ticket_restriction": null,
"shared_phone_number": null,
"only_private_comments": false,
"two_factor_auth_enabled": null
},
"title": "Tedd assigned ticket #1521 to you.",
"object": {
"ticket": {
"id": 1521,
"subject": "test"
}
},
"target": {
"ticket": {
"id": 1521,
"subject": "test"
}
},
"user_id": 3343,
"actor_id": 158488612,
"created_at": "2020-11-17T00:34:40Z",
"updated_at": "2020-11-17T00:34:40Z"
}
],
"previous_page": null
},
"properties": {
"count": {
"type": "integer",
"readOnly": true
},
"users": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"readOnly": true
},
"actors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"readOnly": true
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityObject"
},
"readOnly": true
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
ActivityObject
{
"type": "object",
"title": "Ticket Activities",
"example": {
"id": 35,
"url": "https://company.zendesk.com/api/v2/activities/35.json",
"user": {
"id": 223443,
"name": "Johnny Agent"
},
"verb": "tickets.assignment",
"actor": {
"id": 8678530,
"name": "James A. Rosen"
},
"title": "John Hopeful assigned ticket #123 to you",
"object": {},
"target": {},
"user_id": 29451,
"actor_id": 23546,
"created_at": "2019-03-05T10:38:52Z",
"updated_at": "2019-03-05T10:38:52Z"
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned on creation"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of the activity"
},
"user": {
"$ref": "#/components/schemas/UserObject"
},
"verb": {
"type": "string",
"readOnly": true,
"description": "The type of activity. Can be \"tickets.assignment\", \"tickets.comment\", or \"tickets.priority_increase\""
},
"actor": {
"$ref": "#/components/schemas/UserObject"
},
"title": {
"type": "string",
"readOnly": true,
"description": "Description of the activity"
},
"object": {
"type": "object",
"readOnly": true,
"description": "The content of the activity. Can be a ticket, comment, or change.",
"additionalProperties": true
},
"target": {
"type": "object",
"readOnly": true,
"description": "The target of the activity, a ticket.",
"additionalProperties": true
},
"user_id": {
"type": "integer",
"readOnly": true,
"description": "The id of the agent making the request"
},
"actor_id": {
"type": "integer",
"readOnly": true,
"description": "The id of the user responsible for the ticket activity. An `actor_id` of \"-1\" is a Zendesk system user, such as an automations action."
},
"created_at": {
"type": "string",
"readOnly": true,
"description": "When the record was created"
},
"updated_at": {
"type": "string",
"readOnly": true,
"description": "When the record was last updated"
}
},
"x-konfig-properties": {
"user": {
"type": "object",
"readOnly": true,
"description": "The full user record of the agent making the request. See [Users](https://developer.zendesk.com)"
},
"actor": {
"type": "object",
"readOnly": true,
"description": "The full user record of the user responsible for the ticket activity. See [Users](https://developer.zendesk.com)"
}
}
}
ActivityResponse
{
"type": "object",
"example": {
"activity": {
"id": 29183462,
"url": "https://example.zendesk.com/api/v2/activities/29183462.json",
"user": {
"id": 3343,
"url": "https://example.zendesk.com/api/v2/users/3343.json",
"name": "Samwise Gamgee",
"role": "admin",
"tags": [
"101"
],
"alias": "test",
"email": "user@zendesk.com",
"notes": "test",
"phone": null,
"photo": {
"id": 8730791,
"url": "https://example.zendesk.com/api/v2/attachments/8730791.json",
"size": 4566,
"width": 80,
"height": 80,
"inline": false,
"deleted": false,
"file_name": "1f84950b8d7949b3.gif",
"thumbnails": [
{
"id": 8730801,
"url": "https://example.zendesk.com/api/v2/attachments/8730801.json",
"size": 1517,
"width": 32,
"height": 32,
"inline": false,
"deleted": false,
"file_name": "1f84950b8d7949b3_thumb.gif",
"content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
"content_type": "image/gif",
"mapped_content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif"
}
],
"content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
"content_type": "image/gif",
"mapped_content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif"
},
"active": true,
"locale": "en-gb",
"shared": false,
"details": "",
"verified": true,
"locale_id": 5,
"moderator": true,
"role_type": null,
"signature": "test",
"suspended": false,
"time_zone": "American Samoa",
"created_at": "2017-08-14T20:13:53Z",
"report_csv": true,
"updated_at": "2020-11-17T00:33:55Z",
"external_id": "oev7jj",
"user_fields": {
"skittles": "2018-09-14T00:00:00+00:00",
"user_field_1": "101",
"its_remember_september": null
},
"shared_agent": false,
"last_login_at": "2020-11-16T22:57:45Z",
"custom_role_id": null,
"iana_time_zone": "Pacific/Pago_Pago",
"organization_id": 1873,
"default_group_id": 1873,
"restricted_agent": false,
"ticket_restriction": null,
"shared_phone_number": null,
"only_private_comments": false,
"two_factor_auth_enabled": null
},
"verb": "tickets.assignment",
"actor": {
"id": 158488612,
"url": "https://example.zendesk.com/api/v2/users/158488612.json",
"name": "Tedd",
"role": "admin",
"tags": [],
"alias": "",
"email": "cgoddard+ted@zendesk.com",
"notes": "",
"phone": null,
"photo": null,
"active": true,
"locale": "en-gb",
"shared": false,
"details": "",
"verified": true,
"locale_id": 5,
"moderator": true,
"role_type": null,
"signature": "",
"suspended": false,
"time_zone": "Alaska",
"created_at": "2020-11-17T00:32:12Z",
"report_csv": true,
"updated_at": "2020-11-17T00:34:38Z",
"external_id": null,
"user_fields": {
"skittles": null,
"user_field_1": null,
"its_remember_september": null
},
"shared_agent": false,
"last_login_at": "2020-11-17T00:33:44Z",
"custom_role_id": null,
"iana_time_zone": "America/Juneau",
"organization_id": null,
"default_group_id": 1873,
"restricted_agent": false,
"ticket_restriction": null,
"shared_phone_number": null,
"only_private_comments": false,
"two_factor_auth_enabled": null
},
"title": "Tedd assigned ticket #1521 to you.",
"object": {
"ticket": {
"id": 1521,
"subject": "test"
}
},
"target": {
"ticket": {
"id": 1521,
"subject": "test"
}
},
"user_id": 3343,
"actor_id": 158488612,
"created_at": "2020-11-17T00:34:40Z",
"updated_at": "2020-11-17T00:34:40Z"
}
},
"properties": {
"activity": {
"$ref": "#/components/schemas/ActivityObject"
}
}
}
AssigneeFieldAssignableAgentObject
{
"type": "object",
"title": "AssigneeFieldAssignableAgents",
"example": {
"id": 6473829100,
"name": "Joe Smith",
"avatar_url": "https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png"
},
"properties": {
"id": {
"type": "integer",
"description": "Agent Support ID"
},
"name": {
"type": "string",
"description": "Name of the agent"
},
"avatar_url": {
"type": "string",
"nullable": true,
"description": "URL of Agent's avatar"
}
}
}
AssigneeFieldAssignableGroupAgentsResponse
{
"type": "object",
"example": {
"count": 3,
"agents": [
{
"id": 6473829100,
"name": "Joe Smith",
"avatar_url": "https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png"
},
{
"id": 9182736400,
"name": "Jane Doe",
"avatar_url": "https://z3n-example.zendesk.com/system/photos/412005192023/my_profile.png"
},
{
"id": 1928373460,
"name": "Cookie Monster",
"avatar_url": "https://z3n-example.zendesk.com/system/photos/887005192023/my_profile.png"
}
],
"next_page": null,
"previous_page": null
},
"properties": {
"count": {
"type": "integer",
"description": "Number of agents listed in `agents` property."
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssigneeFieldAssignableAgentObject"
}
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
AssigneeFieldAssignableGroupObject
{
"type": "object",
"title": "AssigneeFieldAssignableGroups",
"example": {
"id": 9182736455,
"name": "Engineering",
"description": "Engineering team for bugs"
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Group ID"
},
"name": {
"type": "string",
"readOnly": true,
"description": "Name of the group"
},
"description": {
"type": "string",
"readOnly": true,
"description": "Description of the group"
}
}
}
AssigneeFieldAssignableGroupsAndAgentsSearchResponse
{
"type": "object",
"example": {
"count": 2,
"agents": [
{
"id": 8392017465,
"name": "Sam Technologist",
"group": "Tech",
"group_id": 6574839201,
"photo_url": "https://z3n-example.zendesk.com/system/photos/410305192023/my_profile.png"
}
],
"groups": [
{
"id": 6574839201,
"name": "Tech"
}
]
},
"properties": {
"count": {
"type": "integer",
"description": "Number of agents + groups listed from search result."
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssigneeFieldAssignableSearchAgentObject"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssigneeFieldAssignableSearchGroupObject"
}
}
}
}
AssigneeFieldAssignableGroupsResponse
{
"type": "object",
"example": {
"count": 3,
"groups": [
{
"id": 9182736455,
"name": "Group for Bugs for Engineering",
"description": "Engineering"
},
{
"id": 1928374655,
"name": "Group for feature requests",
"description": "Product"
},
{
"id": 5519283746,
"name": "Group for customer inquiries",
"description": "Customer Support"
}
],
"next_page": null,
"previous_page": null
},
"properties": {
"count": {
"type": "integer",
"description": "Number of groups listed in `groups` property."
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssigneeFieldAssignableGroupObject"
}
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
AssigneeFieldAssignableSearchAgentObject
{
"type": "object",
"example": {
"id": 6473829100,
"name": "Joe Smith",
"group": "Engineering",
"group_id": 9182736455,
"photo_url": "https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png"
},
"properties": {
"id": {
"type": "integer",
"description": "Agent ID"
},
"name": {
"type": "string",
"description": "Name of the agent"
},
"group": {
"type": "string",
"description": "Name of the agent's group"
},
"group_id": {
"type": "integer",
"description": "Agent's Group ID"
},
"photo_url": {
"type": "string",
"nullable": true,
"description": "URL of Avatar"
}
}
}
AssigneeFieldAssignableSearchGroupObject
{
"type": "object",
"example": {
"id": 9182736455,
"name": "Engineering"
},
"properties": {
"id": {
"type": "integer",
"description": "Group ID"
},
"name": {
"type": "string",
"description": "Name of the group"
}
}
}
AttachmentBaseObject
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "A URL to access the attachment details"
},
"size": {
"type": "integer",
"readOnly": true,
"description": "The size of the image file in bytes"
},
"width": {
"type": "string",
"readOnly": true,
"description": "The width of the image file in pixels. If width is unknown, returns null"
},
"height": {
"type": "string",
"readOnly": true,
"description": "The height of the image file in pixels. If height is unknown, returns null"
},
"inline": {
"type": "boolean",
"readOnly": true,
"description": "If true, the attachment is excluded from the attachment list and the attachment's URL\ncan be referenced within the comment of a ticket. Default is false\n"
},
"deleted": {
"type": "boolean",
"readOnly": true,
"description": "If true, the attachment has been deleted"
},
"file_name": {
"type": "string",
"readOnly": true,
"description": "The name of the image file"
},
"content_url": {
"type": "string",
"readOnly": true,
"description": "A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See [Working with url properties](https://developer.zendesk.com)"
},
"content_type": {
"type": "string",
"readOnly": true,
"description": "The content type of the image. Example value: \"image/png\""
},
"mapped_content_url": {
"type": "string",
"readOnly": true,
"description": "The URL the attachment image file has been mapped to"
},
"malware_scan_result": {
"type": "string",
"readOnly": true,
"description": "The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: \"malware_found\", \"malware_not_found\", \"failed_to_scan\", \"not_scanned\""
},
"malware_access_override": {
"type": "boolean",
"readOnly": true,
"description": "If true, you can download an attachment flagged as malware. If false, you can't download such an attachment."
}
}
}
AttachmentObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AttachmentBaseObject"
},
{
"$ref": "#/components/schemas/AttachmentThumbnails"
}
],
"example": {
"id": 928374,
"size": 166144,
"file_name": "my_funny_profile_pic.png",
"thumbnails": [
{
"id": 928375,
"size": 58298,
"file_name": "my_funny_profile_pic_thumb.png",
"content_url": "https://company.zendesk.com/attachments/my_funny_profile_pic_thumb.png",
"content_type": "image/png"
}
],
"content_url": "https://company.zendesk.com/attachments/my_funny_profile_pic.png",
"content_type": "image/png"
},
"description": "A file represented as an [Attachment](https://developer.zendesk.com) object"
}
AttachmentResponse
{
"type": "object",
"properties": {
"attachment": {
"$ref": "#/components/schemas/AttachmentObject"
}
}
}
AttachmentThumbnails
{
"type": "object",
"properties": {
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentBaseObject"
},
"readOnly": true,
"description": "An array of attachment objects. Note that photo thumbnails do not have thumbnails"
}
}
}
AttachmentUpdateInput
{
"type": "object",
"properties": {
"malware_access_override": {
"type": "boolean",
"description": "If true, allows access to attachments with detected malware."
}
}
}
AttachmentUpdateRequest
{
"type": "object",
"properties": {
"attachment": {
"$ref": "#/components/schemas/AttachmentUpdateInput"
}
}
}
AttachmentUploadResponse
{
"type": "object",
"properties": {
"upload": {
"type": "object",
"properties": {
"token": {
"type": "string",
"readOnly": true,
"description": "Token for subsequent request"
},
"attachment": {
"$ref": "#/components/schemas/AttachmentObject"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentObject"
}
}
}
}
}
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| 2.0.0 | 440 | 454 | 2026-05-11 | current |
| 2.0.0 | 440 | 454 | 2026-04-16 |