Thank you for reaching out. We've reviewed your issue and our technical team is working on a solution. We'll update you as soon as we have more information.
", "plain_body": "Thank you for reaching out. We've reviewed your issue and our technical team is working on a solution. We'll update you as soon as we have more information.", "public": true, "attachments": [ \{ "url": "https://example.zendesk.com/api/v2/attachments/10001.json", "id": 10001, "file_name": "screenshot.png", "content_url": "https://example.zendesk.com/attachments/token/abc123/?name=screenshot.png", "mapped_content_url": "https://example.zendesk.com/attachments/token/abc123/?name=screenshot.png", "content_type": "image/png", "size": 153600, "inline": false, "deleted": false, "thumbnails": [] \}, \{ "url": "https://example.zendesk.com/api/v2/attachments/10002.json", "id": 10002, "file_name": "error_log.txt", "content_url": "https://example.zendesk.com/attachments/token/def456/?name=error_log.txt", "mapped_content_url": "https://example.zendesk.com/attachments/token/def456/?name=error_log.txt", "content_type": "text/plain", "size": 2048, "inline": false, "deleted": false, "thumbnails": [] \} ], "audit_id": 98765, "via": { "channel": "api", "source": { "from": \{ "id": 67890, "title": "Agent Name", "deleted": false \}, "to": {}, "rel": null } } } ], "via": { "channel": "api", "source": { "from": \{ "id": 67890, "title": "Agent Name", "deleted": false \}, "to": {}, "rel": null } } } } ``` ### Count organization members Count the number of members of an organization. **Sample Input** ```json { "organization_id": "123456" } ``` **Sample Output** ### Create automation Create an automation. **Sample Input** ```json { "title": "Auto-assign urgent tickets", "actions": [ { "priority": "urgent" }, { "group_id": "123456" }, { "notification_group": \{ "recipient": "123456", "subject": "Urgent ticket assigned to your group", "body": "An urgent ticket has been automatically assigned to your group. Please review and take action as soon as possible." \} } ], "automation_all": [ \{ "field": "status", "operator": "is", "value": "new" \}, \{ "field": "priority", "operator": "is", "value": "urgent" \}, \{ "field": "NEW", "operator": "less_than", "value": "1" \} ], "active": true, "position": 1 } ``` **Sample Output** ### Create brand Create a brand. **Sample Input** ```json \{ "name": "Acme Support", "subdomain": "acme-support" \} ``` **Sample Output** ### Create group Create a group. **Sample Input** **Sample Output** ```json { "group": \{ "url": "https://example.zendesk.com/api/v2/groups/123456.json", "id": 123456, "name": "Customer Support Team", "description": null, "default": false, "deleted": false, "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z" \} } ``` ### Create group membership Create a group membership entry. This links an agent to a group. **Sample Input** ```json \{ "user_id": 12345, "group_id": 67890 \} ``` **Sample Output** ```json { "group_membership": \{ "url": "https://example.zendesk.com/api/v2/group_memberships/987654", "id": 987654, "user_id": 12345, "group_id": 67890, "default": false, "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z" \} } ``` ### Create group memberships (bulk) Create one or more group membership entries. This links agents to groups. Assigns a maximum of 100 agents to given groups. **Sample Input** **Sample Output** ```json { "job_status": { "id": "job_12345abcde", "url": "https://your-domain.zendesk.com/api/v2/job_statuses/job_12345abcde", "total": 3, "progress": 3, "status": "completed", "message": "3 group memberships created", "results": [ \{ "action": "create", "id": 98765, "status": "success", "success": true \}, \{ "action": "create", "id": 87654, "status": "success", "success": true \}, \{ "action": "create", "id": 76543, "status": "success", "success": true \} ] } } ``` ### Create jira link Create a link to connect between a Jira issue and a Zendesk ticket. **Sample Input** **Sample Output** ### Create macro Create a macro (one or more actions that modify the values of a ticket's fields). **Sample Input** **Sample Output** ### Create or update organization Create or update an organization. **Sample Input** ```json { "required_field": { "name": "Acme Corporation" }, "domain_names": [ "acme.com", "www.acme.com" ], "details": "Global leader in innovative solutions", "notes": "Key account, high priority", "group_id": 12345, "shared_tickets": true, "shared_comments": false, "tags": [ "enterprise", "tech", "priority" ], "organization_fields": [ \{ "key": "account_manager", "value": "John Doe" \}, \{ "key": "contract_renewal_date", "value": "2024-06-30" \} ] } ``` **Sample Output** ### Create organization Create a new organization. **Sample Input** **Sample Output** ### Create organization field Create an organization field. **Sample Input** **Sample Output** ### Create schedule Create a support schedule. **Sample Input** **Sample Output** ```json { "schedule": { "id": 123456, "name": "Customer Support Schedule", "time_zone": "London", "created_at": "2023-06-15T10:30:00Z", "updated_at": "2023-06-15T10:30:00Z", "intervals": [ \{ "start_time": 540, "end_time": 1020 \}, \{ "start_time": 1980, "end_time": 2460 \}, \{ "start_time": 3420, "end_time": 3900 \}, \{ "start_time": 4860, "end_time": 5340 \}, \{ "start_time": 6300, "end_time": 6780 \} ] }, "url": "https://example.zendesk.com/api/v2/business_hours/schedules/123456" } ``` ### Create sla policy Create a service level agreement policy. **Sample Input** **Sample Output** ```json { "sla_policy": { "url": "https://your-domain.zendesk.com/api/v2/sla_policies/12345", "id": 12345, "title": "Premium Support SLA", "description": "SLA policy for premium support customers", "position": 1, "filter": { "all": [ \{ "field": "organization_id", "operator": "is", "value": "123456" \} ], "any": [ \{ "field": "ticket_type_id", "operator": "is", "value": "incident" \}, \{ "field": "ticket_type_id", "operator": "is", "value": "problem" \} ] }, "policy_metrics": [ \{ "business_hours": true, "metric": "first_reply_time", "priority": "urgent", "target": 60 \}, \{ "business_hours": true, "metric": "first_reply_time", "priority": "high", "target": 120 \}, \{ "business_hours": true, "metric": "first_reply_time", "priority": "normal", "target": 240 \}, \{ "business_hours": true, "metric": "first_reply_time", "priority": "low", "target": 480 \} ], "created_at": "2023-06-01T12:00:00Z", "updated_at": "2023-06-01T12:00:00Z" } } ``` ### Create target Create an external target to send notifications to with triggers and automations. **Sample Input** **Sample Output** ```json { "target": \{ "url": "https://example.zendesk.com/api/v2/targets/12345.json", "id": 12345, "created_at": "2023-05-15T10:30:00Z", "type": "email_target", "title": "New Email Notification Target", "active": true \} } ``` ### Create ticket Create a new ticket. **Sample Input** **Sample Output** ```json { "ticket": { "url": "https://company.zendesk.com/api/v2/tickets/1234.json", "id": 1234, "external_id": null, "via": { "channel": "api", "source": { "from": {}, "to": {}, "rel": null } }, "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z", "type": "problem", "subject": "Printer not working", "raw_subject": "Printer not working", "description": "The office printer on the 3rd floor is not responding.", "priority": "high", "status": "open", "recipient": null, "requester_id": 12345, "submitter_id": 12345, "assignee_id": 67890, "organization_id": null, "group_id": 5678, "collaborator_ids": [], "follower_ids": [], "email_cc_ids": [], "forum_topic_id": null, "problem_id": null, "has_incidents": false, "is_public": true, "due_at": null, "tags": [ "hardware", "printer", "3rd-floor" ], "custom_fields": [ \{ "id": 9876, "value": "IT Equipment" \} ], "satisfaction_rating": null, "sharing_agreement_ids": [], "fields": [ \{ "id": 9876, "value": "IT Equipment" \} ], "followup_ids": [], "ticket_form_id": null, "brand_id": null, "satisfaction_probability": null, "allow_channelback": false, "allow_attachments": true }, "audit": { "id": 9876543, "ticket_id": 1234, "created_at": "2023-05-15T10:30:00Z", "author_id": 12345, "metadata": { "system": \{ "client": "Zendesk API", "ip_address": "203.0.113.10", "location": "San Francisco, CA, United States", "latitude": 37.7749, "longitude": -122.4194 \}, "custom": {} }, "events": [ { "id": 123456789, "type": "Comment", "author_id": 12345, "body": "I've tried restarting the printer, but it's still not working. Can someone please take a look?", "html_body": "I've tried restarting the printer, but it's still not working. Can someone please take a look?
", "plain_body": "I've tried restarting the printer, but it's still not working. Can someone please take a look?", "public": true, "attachments": [], "audit_id": 9876543, "via": { "channel": "api", "source": { "from": {}, "to": {}, "rel": null } } } ], "via": { "channel": "api", "source": { "from": {}, "to": {}, "rel": null } } } } ``` ### Create ticket field Create a ticket field. **Sample Input** **Sample Output** ### Create ticket form Create a ticket form. **Sample Input** ```json { "name": "Customer Support Form", "position": 1, "display_name": "Support Request", "end_user_visible": true, "active": true, "default": false, "in_all_brands": true, "ticket_field_ids": [ 123, 456, 789 ], "agent_conditions": [ { "parent_field_id": 123, "value": "high", "child_fields": [ { "id": 456, "is_required": true, "required_on_statuses": \{ "type": "SOME_STATUSES", "statuses": [ "new", "open" ] \} } ] } ], "end_user_conditions": [ { "parent_field_id": 789, "value": "billing", "child_fields": [ \{ "id": 456, "is_required": true \} ] } ] } ``` **Sample Output** ### Create trigger Create a trigger (one or more actions performed when a ticket is created or updated). **Sample Input** ```json { "title": "High Priority Support Ticket", "description": "Automatically assign high priority tickets to the urgent support group", "active": true, "trigger_actions": [ \{ "field": "group_id", "value": "123456" \}, \{ "field": "priority", "value": "urgent" \} ], "category_id": "200", "position": 1, "conditions": { "all": [ \{ "field": "priority", "operator": "is", "value": "high" \}, \{ "field": "status", "operator": "is", "value": "new" \} ], "any": [ \{ "field": "subject_includes_word", "operator": "includes", "value": "urgent" \}, \{ "field": "comment_includes_word", "operator": "includes", "value": "critical" \} ] } } ``` **Sample Output** ### Create user Create a new user. **Sample Input** **Sample Output** ```json { "user": { "id": 987654, "url": "https://example.zendesk.com/api/v2/users/987654.json", "name": "John Doe", "email": "johndoe@example.com", "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z", "time_zone": "America/New_York", "iana_time_zone": "America/New_York", "phone": "+1 555-123-4567", "shared_phone_number": false, "photo": { "id": 12345, "name": "profile_picture.jpg", "content_url": "https://example.zendesk.com/system/photos/12345/profile_picture.jpg", "content_type": "image/jpeg", "size": 102400, "thumbnails": [ \{ "id": 67890, "name": "profile_picture_thumb.jpg", "content_url": "https://example.zendesk.com/system/photos/67890/profile_picture_thumb.jpg", "content_type": "image/jpeg", "size": 10240 \} ] }, "locale_id": 1, "locale": "en-US", "organization_id": 67890, "role": "agent", "verified": true, "external_id": "EXT12345", "tags": [ "vip", "tech-savvy" ], "alias": "JD", "active": true, "shared": false, "shared_agent": false, "last_login_at": "2023-05-15T10:35:00Z", "two_factor_auth_enabled": false, "signature": "Best regards,\nJohn Doe\nCustomer Support", "details": "Office location: New York", "notes": "Experienced support agent with 5 years of experience", "role_type": "agent", "custom_role_id": 12345, "moderator": false, "ticket_restriction": "groups", "only_private_comments": false, "restricted_agent": false, "suspended": false, "chat_only": false, "default_group_id": 54321, "report_csv": true, "user_fields": \{ "department": "IT Support", "employee_id": "EMP001" \} } } ``` ### Create user field Create a custom user field. **Sample Input** **Sample Output** ### Create user identity Create an identity for a user. **Sample Input** **Sample Output** ### Create view Create a view. **Sample Input** **Sample Output** ### Create/update user Create a new user if the user does not already exist or update an existing user identified by e-mail address or external ID. To create a new user, please provide a name. To update an existing user, please provide either an email address or external ID **Sample Input** **Sample Output** ```json { "user": { "id": 987654, "url": "https://example.zendesk.com/api/v2/users/987654.json", "name": "John Doe", "email": "johndoe@example.com", "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z", "time_zone": "America/New_York", "iana_time_zone": "America/New_York", "phone": "+1 555-123-4567", "shared_phone_number": false, "photo": null, "locale_id": 1, "locale": "en-US", "organization_id": 123456, "role": "end-user", "verified": true, "external_id": "CUS-001", "tags": [ "vip", "new_customer" ], "alias": "JD", "active": true, "shared": false, "shared_agent": false, "last_login_at": null, "two_factor_auth_enabled": false, "signature": "Best regards,\nJohn Doe", "details": "Address: 123 Main St, Anytown, USA", "notes": "Prefers email communication", "role_type": null, "custom_role_id": null, "moderator": false, "ticket_restriction": "organization", "only_private_comments": false, "restricted_agent": false, "suspended": false, "chat_only": false, "default_group_id": null, "report_csv": false, "user_fields": \{ "department": "Sales", "employee_id": "EMP001" \} } } ``` ### Delete group membership Removes an agent from a group **Sample Input** **Sample Output** ### Delete group memberships (bulk) Removes an agent from a group. **Sample Input** **Sample Output** ### Delete jira link Delete a link between a Jira issue and a Zendesk ticket. **Sample Input** **Sample Output** ### Delete ticket Delete a ticket. **Sample Input** **Sample Output** ### Delete ticket form Delete a ticket form. **Sample Input** **Sample Output** ### Delete ticket tags Delete tags from a ticket. **Sample Input** **Sample Output** ### Delete user field Delete a custom user field. **Sample Input** **Sample Output** ### Delete user identity Delete a specified user identity. **Sample Input** **Sample Output** ```json { "success": true } ``` ### Filter articles Filter articles by specified fields. **Sample Input** **Sample Output** ### Get article Retrieve a specific article. **Sample Input** ```json { "article_id": 12345 } ``` **Sample Output** ### Get article attachment Retrieve a specific article attachment. **Sample Input** **Sample Output** ### Get article comment Retrieve a specific article comment from knowledge base. **Sample Input** **Sample Output** ### Get group membership Retrieve a group membership. **Sample Input** ```json \{ "group_membership_id": 123456, "user_id": 987654 \} ``` **Sample Output** ### Get label Retrieve a specific label. **Sample Input** **Sample Output** ### Get organization Get information about an organization. **Sample Input** **Sample Output** ### Get organization custom field Retrieve an organization custom field. **Sample Input** ```json { "organization_field_id": "360001234567" } ``` **Sample Output** ### Get settings Retrieve the settings that are available for the account. **Sample Input** **Sample Output** ### Get ticket Get information about a specific ticket. **Sample Input** **Sample Output** ### Get ticket audit Get information about a specific ticket audit. **Sample Input** **Sample Output** ### Get ticket form Get information about a specific ticket form. **Sample Input** **Sample Output** ### Get user Retrieve a specified user. **Sample Input** **Sample Output** ```json { "user": { "id": 12345, "url": "https://example.zendesk.com/api/v2/users/12345.json", "name": "John Doe", "email": "johndoe@example.com", "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T14:45:00Z", "time_zone": "America/New_York", "iana_time_zone": "America/New_York", "phone": "+1 555-123-4567", "shared_phone_number": null, "photo": "https://example.zendesk.com/system/photos/12345/avatar.png", "locale_id": 1, "locale": "en-US", "organization_id": 67890, "role": "agent", "verified": true, "external_id": "EXT-12345", "tags": [ "support", "billing" ], "alias": "JD", "active": true, "shared": false, "shared_agent": false, "last_login_at": "2023-05-15T09:00:00Z", "two_factor_auth_enabled": true, "signature": "Best regards,\nJohn Doe\nCustomer Support", "details": "Senior Support Agent", "notes": "Specializes in technical issues", "role_type": null, "custom_role_id": null, "moderator": false, "ticket_restriction": "none", "only_private_comments": false, "restricted_agent": false, "suspended": false, "chat_only": false, "default_group_id": 54321, "report_csv": true, "user_fields": \{ "meteor_url": "https://meteor.example.com/users/12345", "recurly_url": "https://recurly.example.com/users/12345", "sample_user_field": "Sample Value", "tickets_allowed": true \} } } ``` ### Import ticket Imports a ticket to Zendesk from a legacy system. Unlike 'Create ticket', this operation allows you to set system parameters like 'created\_at', 'updated\_at', and 'solved\_at'. **Sample Input** **Sample Output** ### List article attachments List all attachments in a specific article. **Sample Input** **Sample Output** ### List article comments List the comments created by a specific user, or all comments made by all users on a specific article. **Sample Input** **Sample Output** ### List article labels Retrieve all labels given to a specific article. **Sample Input** ```json \{ "article_id": 123456, "page_size": 50, "page_after": "eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA4OjMwOjAwWiJ9" \} ``` **Sample Output** ### List article translations Retrieve translations for a specific article. **Sample Input** **Sample Output** ### List articles Retrieve list of all articles. **Sample Input** **Sample Output** ### List audits for a ticket List the audits linked to a specific ticket. **Sample Input** **Sample Output** ```json { "audits": [ { "id": 987654, "ticket_id": 12345, "created_at": "2023-05-15T14:30:00Z", "author_id": 67890, "metadata": { "system": \{ "client": "web_browser", "ip_address": "192.168.1.100", "location": "New York, USA", "latitude": 40.7128, "longitude": -74.006 \}, "custom": {} }, "events": [ { "id": 111222, "type": "Comment", "via": { "channel": "web", "source": { "from": \{ "deleted": false, "title": "John Doe", "id": 67890, "revision_id": 1 \}, "rel": "user" } }, "resource": "ticket", "body": "This is a sample comment on the ticket." } ], "via": { "channel": "web", "source": { "from": \{ "deleted": false, "title": "John Doe", "id": 67890 \}, "to": {}, "rel": "user" } } } ], "meta": \{ "has_more": true, "after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==", "before_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==" \}, "links": \{ "prev": "https://your-domain.zendesk.com/api/v2/tickets/12345/audits.json?page[size]=50&page[before]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==", "next": "https://your-domain.zendesk.com/api/v2/tickets/12345/audits.json?page[size]=50&page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==" \} } ``` ### List brands Retrieve a list of all brands for your account sorted by name. **Sample Input** **Sample Output** ### List categories List all categories in knowledge base. **Sample Input** **Sample Output** ### List custom user roles Retrieve a list of custom user roles. **Sample Input** **Sample Output** ### List group memberships List the group memberships e.g. list the agents and the groups that they are assigned to. **Sample Input** **Sample Output** ### List groups Get a list of all of the groups in your Zendesk account. **Sample Input** **Sample Output** ```json { "groups": [ \{ "url": "https://example.zendesk.com/api/v2/groups/123.json", "id": 123, "is_public": true, "name": "Support Team", "description": "Handles customer support tickets", "default": false, "deleted": false, "created_at": "2023-01-15T10:00:00Z", "updated_at": "2023-05-01T14:30:00Z", "user_ids": [ 1001, 1002, 1003 ] \}, \{ "url": "https://example.zendesk.com/api/v2/groups/124.json", "id": 124, "is_public": false, "name": "Sales Team", "description": "Handles sales inquiries", "default": false, "deleted": false, "created_at": "2023-02-01T09:00:00Z", "updated_at": "2023-04-15T11:45:00Z", "user_ids": [ 2001, 2002 ] \} ], "users": [ \{ "id": 1001, "name": "John Doe", "email": "john.doe@example.com" \}, \{ "id": 1002, "name": "Jane Smith", "email": "jane.smith@example.com" \} ], "meta": \{ "has_more": true, "after_cursor": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE2OjAwOjAwWiJ9", "before_cursor": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9" \}, "links": \{ "prev": "https://example.zendesk.com/api/v2/groups.json?page[size]=50&page[before]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9", "next": "https://example.zendesk.com/api/v2/groups.json?page[size]=50&page[after]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE2OjAwOjAwWiJ9" \} } ``` ### List labels List all labels in knowledge base that can be applied to articles. **Sample Input** **Sample Output** ### List locales Retrieve a list of locales available to the account. **Sample Input** ```json \{ "per_page": 50, "page": 1 \} ``` **Sample Output** ### List organization fields Get a list of all of the available organization fields in your Zendesk account. **Sample Input** ```json \{ "per_page": 50, "next_page_token": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==" \} ``` **Sample Output** ```json { "organization_fields": [ \{ "url": "https://example.zendesk.com/api/v2/organization_fields/123456", "id": 123456, "type": "text", "key": "custom_field_1", "title": "Company Size", "description": "Number of employees in the organization", "raw_title": "Company Size", "raw_description": "Number of employees in the organization", "position": 1, "active": true, "system": false, "regexp_for_validation": null, "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z" \}, \{ "url": "https://example.zendesk.com/api/v2/organization_fields/123457", "id": 123457, "type": "dropdown", "key": "custom_field_2", "title": "Industry", "description": "The primary industry of the organization", "raw_title": "Industry", "raw_description": "The primary industry of the organization", "position": 2, "active": true, "system": false, "regexp_for_validation": null, "created_at": "2023-05-15T11:00:00Z", "updated_at": "2023-05-15T11:00:00Z" \} ], "meta": \{ "has_more": true, "after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==", "before_cursor": null \}, "links": \{ "prev": null, "next": "https://example.zendesk.com/api/v2/organization_fields?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==" \} } ``` ### List organization memberships Get a list of all of the memberships (users) attached to this organization. **Sample Input** **Sample Output** ### List organizations Get a list of all of the organizations in your Zendesk account, grouped into pages. **Sample Input** **Sample Output** ### List sections List sections. **Sample Input** **Sample Output** ### List ticket comments List the comments (both public and private) linked to a specific ticket. **Sample Input** **Sample Output** ### List ticket fields Get a list of all the ticket fields. **Sample Input** **Sample Output** ### List ticket forms List of all ticket forms for your account if accessed as an admin or agent. **Sample Input** **Sample Output** ### List ticket tags List the tags linked to a specific ticket. **Sample Input** **Sample Output** ### List tickets Get a list of all the tickets. **Sample Input** **Sample Output** ### List tickets for organization Get a list of all the tickets for an organization. **Sample Input** **Sample Output** ### List tickets for user Get a list of all the tickets for a user. **Sample Input** **Sample Output** ### List translations List all translations for a given article, section, or category. **Sample Input** **Sample Output** ### List triggers Retrieve a list of triggers for the current account. **Sample Input** **Sample Output** ### List user fields Retrieve a list of user fields. **Sample Input** **Sample Output** ```json { "user_fields": [ { "url": "https://example.zendesk.com/api/v2/user_fields/123456", "id": 123456, "type": "text", "key": "customer_id", "title": "Customer ID", "description": "Unique identifier for the customer", "raw_title": "Customer ID", "raw_description": "Unique identifier for the customer", "position": 1, "active": true, "system": false, "regexp_for_validation": "^[A-Z]{2}\\d{6}$", "created_at": "2023-05-01T09:00:00Z", "updated_at": "2023-05-01T09:00:00Z" }, \{ "url": "https://example.zendesk.com/api/v2/user_fields/123457", "id": 123457, "type": "dropdown", "key": "account_type", "title": "Account Type", "description": "Type of customer account", "raw_title": "Account Type", "raw_description": "Type of customer account", "position": 2, "active": true, "system": false, "regexp_for_validation": null, "created_at": "2023-05-02T10:30:00Z", "updated_at": "2023-05-02T10:30:00Z" \} ], "meta": \{ "has_more": true, "after_cursor": "eyJvIjoiMjAyMy0wNS0wMlQxMDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9", "before_cursor": "eyJvIjoiMjAyMy0wNS0wMVQwOTowMDowMC4wMDBaIiwiZCI6ImRlc2MifQ==" \}, "links": \{ "prev": "https://example.zendesk.com/api/v2/user_fields?page[size]=2&page[before]=eyJvIjoiMjAyMy0wNS0wMVQwOTowMDowMC4wMDBaIiwiZCI6ImRlc2MifQ==", "next": "https://example.zendesk.com/api/v2/user_fields?page[size]=2&page[after]=eyJvIjoiMjAyMy0wNS0wMlQxMDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9" \} } ``` ### List user identities Get a list of all of a user's identities, including emails and phone numbers. **Sample Input** **Sample Output** ### Make user identity primary Make one of a user's identities the primary identity. **Sample Input** **Sample Output** ### Raw HTTP request (advanced) Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. **Sample Input** **Sample Output** ### Search Search for tickets, users, and organizations by query parameter. **Sample Input** **Sample Output** ```json { "count": 25, "facets": null, "next_page": "https://your-domain.zendesk.com/api/v2/search.json?page=2&query=status:open+priority:high", "previous_page": null, "results": [ \{ "created_at": "2023-05-15T14:30:22Z", "id": 12345, "name": "Urgent server downtime issue", "result_type": "ticket", "updated_at": "2023-05-15T15:45:10Z", "url": "https://your-domain.zendesk.com/api/v2/tickets/12345.json" \}, \{ "created_at": "2023-05-14T09:12:05Z", "id": 12344, "name": "Critical payment gateway error", "result_type": "ticket", "updated_at": "2023-05-14T10:30:18Z", "url": "https://your-domain.zendesk.com/api/v2/tickets/12344.json" \} ] } ``` ### Search organization by name Search for organizations using the name of the organization. **Sample Input** **Sample Output** ### Search organizations by External ID. Search for organizations using the value of an "External ID" field previously set. **Sample Input** **Sample Output** ### Update organization Update an organization. **Sample Input** ```json { "organization_id": 123456, "name": "Acme Corporation", "external_id": "ACME001", "domain_names": [ "acme.com", "acmecorp.com" ], "details": "Global technology company", "notes": "Key account, high priority", "group_id": 78901, "shared_tickets": true, "shared_comments": false, "tags": [ "enterprise", "technology", "vip" ], "organization_fields": [ \{ "key": "account_manager", "value": "John Doe" \}, \{ "key": "contract_renewal_date", "value": "2023-12-31" \} ] } ``` **Sample Output** ### Update organization field Update an organization field using a specified organization ID. **Sample Input** **Sample Output** ### Update ticket Update information about a ticket. **Sample Input** ```json { "ticket_id": 12345, "subject": "Updated: Issue with login page", "comment": \{ "body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.", "public": true, "author_id": "1234567890" \}, "status": "open", "priority": "high", "assignee_id": 9876, "tags": [ "login", "website", "in-progress" ], "custom_fields": [ \{ "id": 360001234567, "value": "Web team" \} ] } ``` **Sample Output** ```json { "ticket": { "url": "https://example.zendesk.com/api/v2/tickets/12345.json", "id": 12345, "external_id": null, "via": { "channel": "api", "source": { "from": {}, "to": {}, "rel": null } }, "created_at": "2023-06-15T10:30:00Z", "updated_at": "2023-06-15T14:45:00Z", "type": "incident", "subject": "Updated: Issue with login page", "raw_subject": "Updated: Issue with login page", "description": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.", "priority": "high", "status": "open", "recipient": "customer@example.com", "requester_id": 67890, "submitter_id": 1234567890, "assignee_id": 9876, "organization_id": 5678, "group_id": 1122, "collaborator_ids": [], "follower_ids": [], "email_cc_ids": [], "forum_topic_id": null, "problem_id": null, "has_incidents": false, "is_public": true, "due_at": null, "tags": [ "login", "website", "in-progress" ], "custom_fields": [ \{ "id": 360001234567, "value": "Web team" \} ], "satisfaction_rating": null, "sharing_agreement_ids": [], "fields": [ \{ "id": 360001234567, "value": "Web team" \} ], "followup_ids": [], "ticket_form_id": 98765, "brand_id": 123456, "satisfaction_probability": null, "allow_channelback": true, "allow_attachments": true }, "audit": { "id": 987654321, "ticket_id": 12345, "created_at": "2023-06-15T14:45:00Z", "author_id": 1234567890, "metadata": { "system": \{ "client": "Tray.io", "ip_address": "203.0.113.0", "location": "San Francisco, CA, United States", "latitude": 37.7749, "longitude": -122.4194 \}, "custom": {} }, "events": [ { "id": 456789, "type": "Comment", "author_id": 1234567890, "body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.", "html_body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.
", "plain_body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.", "public": true, "attachments": [], "audit_id": 987654321, "via": { "channel": "api", "source": { "from": {}, "to": {}, "rel": null } } } ], "via": { "channel": "api", "source": { "from": {}, "to": {}, "rel": null } } } } ``` ### Update user Update an existing user. **Sample Input** ```json { "user_id": 12345, "name": "John Smith", "email": "john.smith@example.com", "role": "agent", "phone": "+1 555-123-4567", "organization_id": 67890, "alias": "JS", "locale": "en-US", "time_zone": "America/New_York", "signature": "Best regards,\nJohn Smith\nCustomer Support", "tags": [ "vip", "priority" ], "ticket_restriction": "groups", "user_fields": [ \{ "key": "department", "value": "Sales" \}, \{ "key": "employee_id", "value": "EMP001" \} ], "notes": "Experienced agent with excellent customer service skills", "details": "Office location: New York", "external_id": "EXT12345" } ``` **Sample Output** ```json { "user": { "id": 12345, "url": "https://example.zendesk.com/api/v2/users/12345.json", "name": "John Smith", "email": "john.smith@example.com", "created_at": "2023-01-15T10:00:00Z", "updated_at": "2023-06-01T14:30:00Z", "time_zone": "America/New_York", "iana_time_zone": "America/New_York", "phone": "+1 555-123-4567", "shared_phone_number": false, "photo": { "id": 98765, "name": "john_smith.jpg", "content_url": "https://example.zendesk.com/system/photos/9876/5432/john_smith.jpg", "content_type": "image/jpeg", "size": 12345, "thumbnails": [ \{ "id": 54321, "name": "john_smith_thumb.jpg", "content_url": "https://example.zendesk.com/system/photos/5432/1098/john_smith_thumb.jpg", "content_type": "image/jpeg", "size": 5678 \} ] }, "locale_id": 1, "locale": "en-US", "organization_id": 67890, "role": "agent", "verified": true, "external_id": "EXT12345", "tags": [ "vip", "priority" ], "alias": "JS", "active": true, "shared": false, "shared_agent": false, "last_login_at": "2023-05-31T09:15:00Z", "two_factor_auth_enabled": true, "signature": "Best regards,\nJohn Smith\nCustomer Support", "details": "Office location: New York", "notes": "Experienced agent with excellent customer service skills", "role_type": null, "custom_role_id": null, "moderator": false, "ticket_restriction": "groups", "only_private_comments": false, "restricted_agent": false, "suspended": false, "chat_only": false, "default_group_id": 11111, "report_csv": true, "user_fields": \{ "department": "Sales", "employee_id": "EMP001" \} } } ``` ### Update user field Update information about a user field. **Sample Input** **Sample Output** ```json { "user_field": { "url": "https://example.zendesk.com/api/v2/user_fields/123456", "id": 123456, "type": "text", "key": "customer_preference", "title": "Customer Preference", "description": "Customer's preferred communication method", "raw_title": "\{\{dc.customer_preference\}\}", "raw_description": "\{\{dc.customer_preference_description\}\}", "position": 3, "active": true, "system": false, "regexp_for_validation": "^(email|phone|mail)$", "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T14:45:00Z" } } ``` ### Upload attachment Upload a file attachment to Zendesk. A token will be returned, allowing you to attach files to tickets. **Sample Input** **Sample Output** ```json { "upload": { "token": "6bk3gql5ktbm7tqkt8lfTa", "expires_at": "2023-05-15T10:30:00Z", "attachments": [ \{ "url": "https://company.zendesk.com/api/v2/attachments/123456789.json", "id": 123456789, "file_name": "support_document.pdf", "content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf", "mapped_content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf", "content_type": "application/pdf", "size": 1024000, "width": null, "height": null, "inline": false, "deleted": false, "thumbnails": [] \} ], "attachment": \{ "url": "https://company.zendesk.com/api/v2/attachments/123456789.json", "id": 123456789, "file_name": "support_document.pdf", "content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf", "mapped_content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf", "content_type": "application/pdf", "size": 1024000, "width": null, "height": null, "inline": false, "deleted": false, "thumbnails": [] \} } } ``` ## DDL operations ### List agents (DDL) **Sample Input** ```json {} ``` **Sample Output** ```json [ \{ "id": 1234567, "name": "John Doe", "email": "johndoe@example.com", "role": "agent", "active": true, "time_zone": "America/Los_Angeles", "phone": "+1 555-123-4567", "created_at": "2023-05-15T09:30:00Z", "updated_at": "2023-05-15T09:30:00Z" \}, \{ "id": 2345678, "name": "Jane Smith", "email": "janesmith@example.com", "role": "admin", "active": true, "time_zone": "Europe/London", "phone": "+44 20 1234 5678", "created_at": "2023-05-14T14:45:00Z", "updated_at": "2023-05-15T10:15:00Z" \} ] ``` ### List article attachments (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** ```json {} ``` **Sample Output** ### List article comments (DDL) **Sample Input** **Sample Output** ### List articles (DDL) **Sample Input** **Sample Output** ### List audits for a ticket (DDL) **Sample Input** **Sample Output** ```json { "audits": [ { "id": 123456789, "ticket_id": 987654, "created_at": "2023-05-15T10:30:00Z", "author_id": 12345, "events": [ \{ "id": 987654321, "type": "Comment", "author_id": 12345, "body": "This is a comment added to the ticket.", "public": true, "created_at": "2023-05-15T10:30:00Z" \}, \{ "id": 987654322, "type": "Change", "field_name": "status", "value": "open", "previous_value": "new" \} ] }, { "id": 123456790, "ticket_id": 987654, "created_at": "2023-05-15T11:45:00Z", "author_id": 67890, "events": [ \{ "id": 987654323, "type": "Change", "field_name": "priority", "value": "high", "previous_value": "normal" \} ] } ], "next_page": "https://your-subdomain.zendesk.com/api/v2/tickets/987654/audits.json?page=2", "previous_page": null, "count": 2 } ``` ### List categories (DDL) **Sample Input** **Sample Output** ```json [ \{ "id": 123456, "name": "General Support", "description": "General customer support inquiries", "position": 1, "created_at": "2023-05-01T10:00:00Z", "updated_at": "2023-05-01T10:00:00Z" \}, \{ "id": 234567, "name": "Technical Issues", "description": "Technical problems and troubleshooting", "position": 2, "created_at": "2023-05-01T10:15:00Z", "updated_at": "2023-05-01T10:15:00Z" \}, \{ "id": 345678, "name": "Billing", "description": "Billing and payment related queries", "position": 3, "created_at": "2023-05-01T10:30:00Z", "updated_at": "2023-05-01T10:30:00Z" \} ] ``` ### List custom user roles (DDL) **Sample Input** ```json {} ``` **Sample Output** ```json { "custom_roles": [ \{ "id": 1234567, "name": "Support Specialist", "description": "Handles customer support tickets", "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z", "role_type": "custom" \}, \{ "id": 2345678, "name": "Billing Manager", "description": "Manages billing and invoicing", "created_at": "2023-05-16T09:15:00Z", "updated_at": "2023-05-16T09:15:00Z", "role_type": "custom" \}, \{ "id": 3456789, "name": "Product Specialist", "description": "Handles product-related inquiries", "created_at": "2023-05-17T14:45:00Z", "updated_at": "2023-05-17T14:45:00Z", "role_type": "custom" \} ] } ``` ### List groups (DDL) **Sample Input** **Sample Output** ```json [ \{ "id": 123456, "name": "Support Team", "url": "https://example.zendesk.com/api/v2/groups/123456.json", "deleted": false, "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z" \}, \{ "id": 234567, "name": "Sales Team", "url": "https://example.zendesk.com/api/v2/groups/234567.json", "deleted": false, "created_at": "2023-05-15T11:00:00Z", "updated_at": "2023-05-15T11:00:00Z" \}, \{ "id": 345678, "name": "Product Team", "url": "https://example.zendesk.com/api/v2/groups/345678.json", "deleted": false, "created_at": "2023-05-15T11:30:00Z", "updated_at": "2023-05-15T11:30:00Z" \} ] ``` ### List labels (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** ```json {} ``` **Sample Output** ### List locales (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List organization fields ID (DDL) **Sample Input** **Sample Output** ```json [ \{ "id": 360000246234, "title": "Industry" \}, \{ "id": 360000246254, "title": "Company Size" \}, \{ "id": 360000246274, "title": "Annual Revenue" \}, \{ "id": 360000246294, "title": "Region" \} ] ``` ### List organization fields key (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List organizations (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List sections (DDL) **Sample Input** **Sample Output** ### List ticket active custom fields (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ```json [ { "id": 360001234567, "title": "Priority", "type": "dropdown", "options": [ \{ "id": 360001111111, "name": "Low", "value": "low" \}, \{ "id": 360002222222, "name": "Medium", "value": "medium" \}, \{ "id": 360003333333, "name": "High", "value": "high" \} ] }, \{ "id": 360009876543, "title": "Product", "type": "text", "options": [] \}, \{ "id": 360005555555, "title": "Due Date", "type": "date", "options": [] \} ] ``` ### List ticket active fields (DDL) **Sample Input** **Sample Output** ```json [ \{ "id": 360001234567, "title": "Subject", "type": "subject", "description": "Ticket subject", "position": 1, "active": true, "required": true, "collapsed_for_agents": false, "regexp_for_validation": null, "title_in_portal": "Subject", "visible_in_portal": true, "editable_in_portal": true, "required_in_portal": true, "tag": null, "created_at": "2023-05-01T10:00:00Z", "updated_at": "2023-05-01T10:00:00Z" \}, \{ "id": 360001234568, "title": "Description", "type": "description", "description": "Ticket description", "position": 2, "active": true, "required": true, "collapsed_for_agents": false, "regexp_for_validation": null, "title_in_portal": "Description", "visible_in_portal": true, "editable_in_portal": true, "required_in_portal": true, "tag": null, "created_at": "2023-05-01T10:00:00Z", "updated_at": "2023-05-01T10:00:00Z" \}, \{ "id": 360001234569, "title": "Status", "type": "status", "description": "Ticket status", "position": 3, "active": true, "required": true, "collapsed_for_agents": false, "regexp_for_validation": null, "title_in_portal": "Status", "visible_in_portal": true, "editable_in_portal": false, "required_in_portal": false, "tag": null, "created_at": "2023-05-01T10:00:00Z", "updated_at": "2023-05-01T10:00:00Z" \} ] ``` ### List ticket forms (DDL) **Sample Input** **Sample Output** ### List ticket tags (DDL) **Sample Input** **Sample Output** ### List user fields (DDL) **Sample Input** **Sample Output** ### List user fields keys (DDL) **Sample Input** **Sample Output** ### List user identities (DDL) **Sample Input** **Sample Output** ### List users (DDL) **Sample Input** ```json {} ``` **Sample Output** ```json [ \{ "id": 1234567890, "name": "John Doe", "email": "johndoe@example.com", "created_at": "2023-05-15T10:30:00Z", "updated_at": "2023-05-15T10:30:00Z", "time_zone": "America/New_York", "phone": "+1 555-123-4567", "role": "agent", "verified": true, "active": true, "last_login_at": "2023-05-15T09:45:00Z", "locale": "en-US", "organization_id": 9876543210, "tags": [ "support", "tier1" ] \}, \{ "id": 2345678901, "name": "Jane Smith", "email": "janesmith@example.com", "created_at": "2023-05-14T14:20:00Z", "updated_at": "2023-05-14T14:20:00Z", "time_zone": "Europe/London", "phone": "+44 20 1234 5678", "role": "admin", "verified": true, "active": true, "last_login_at": "2023-05-15T08:30:00Z", "locale": "en-GB", "organization_id": 9876543210, "tags": [ "management", "billing" ] \} ] ```