To use input field payload with data types, such as array, boolean, double, or integer, you must use annotation as shown in the following sample code:
- •The Create Object action creates a single record of the specified entity type.
The following snippet is a sample request payload to create a single ticket:
<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<ticket>
<subject>My laptop is broken</subject>
<description>Keyboard buttons have no effect</description>
<comments>
<value>Escape btn doesn't work</value>
</comments>
</ticket>
</root>
The following snippet is a sample response payload example of the created ticket:
<root>
<ticket>
<encoded_id>VVEYX4-DDWEE</encoded_id>
<from_messaging_channel>false</from_messaging_channel>
<subject>My laptop is broken</subject>
<email_cc_ids/>
<created_at>2025-02-07T00:26:45Z</created_at>
<description>Keyboard buttons have no effect</description>
<custom_status_id>13206351</custom_status_id>
<external_id/>
<type/>
<via>
<channel>api</channel>
<source>
<rel/>
<from/>
<to/>
</source>
</via>
<allow_attachments>true</allow_attachments>
<updated_at>2025-02-07T00:26:45Z</updated_at>
<problem_id/>
<follower_ids/>
<due_at/>
<id>69947</id>
<generated_timestamp>0</generated_timestamp>
<assignee_id/>
<raw_subject>My laptop is broken</raw_subject>
<forum_topic_id/>
<custom_fields>
<id>1900001016587</id>
<value/>
</custom_fields>
<custom_fields>
<id>5313441454221</id>
<value/>
</custom_fields>
<allow_channelback>false</allow_channelback>
<satisfaction_rating>
<score>unoffered</score>
</satisfaction_rating>
<submitter_id>363369298572</submitter_id>
<priority/>
<collaborator_ids/>
<url>https://d3v-infacloud.zendesk.com/api/v2/tickets/69947.json</url>
<tags/>
<brand_id>360000485092</brand_id>
<ticket_form_id>360000143632</ticket_form_id>
<sharing_agreement_ids/>
<group_id/>
<organization_id>360044286132</organization_id>
<followup_ids/>
<recipient/>
<is_public>true</is_public>
<has_incidents>false</has_incidents>
<fields>
<id>1900001016587</id>
<value/>
</fields>
<fields>
<id>5313441454221</id>
<value/>
</fields>
<status>new</status>
<requester_id>363369298572</requester_id>
</ticket>
<audit>
<created_at>2025-02-07T00:26:45Z</created_at>
<id>34106895877517</id>
<ticket_id>69947</ticket_id>
<author_id>363369298572</author_id>
<events>
<audit_id>34106895877517</audit_id>
<attachments/>
<public>true</public>
<html_body><div class="zd-comment" dir="auto"><p dir="auto">Keyboard buttons have no effect</p></div></html_body>
<plain_body>Keyboard buttons have no effect</plain_body>
<id>34106895877645</id>
<type>Comment</type>
<body>Keyboard buttons have no effect</body>
<author_id>363369298572</author_id>
</events>
<via>
<channel>api</channel>
<source>
<rel/>
<from/>
<to/>
</source>
</via>
</audit>
</root>
- •The Delete Object action deletes a single object for the specified entity type and entity ID.
For example, to delete the ticket with ID 69947, you must set the entityType as tickets and entityId as 69947 as shown in the following URL:
https://{domain}.zendesk.com/api/v2/tickets/69947
If the object is deleted successfully, the object returns the response status code 204 without content.
- •The Get Objects action retrieves records for the specified entity type. You can construct a request URL using segments 1- 6. You can also pass query parameters to the action using the queryParams object.
The following snippet is a sample response to the query ticket by ID:
- •The Update Object action updates the specified record with the name-value pairs of the parameters included in the request body.
The following snippet is a sample request payload to update a single ticket:
<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<ticket>
<external_id>1234</external_id>
</ticket>
</root>
The following snippet is a sample response to the update ticket action:
<root>
<ticket>
<encoded_id>VVEYX4-DDWEE</encoded_id>
<from_messaging_channel>false</from_messaging_channel>
<subject>My laptop is broken</subject>
<email_cc_ids/>
<created_at>2025-02-07T00:26:45Z</created_at>
<description>Keyboard buttons have no effect</description>
<custom_status_id>13206351</custom_status_id>
<external_id>1234</external_id>
<type/>
<via>
<channel>api</channel>
<source>
<rel/>
<from/>
<to/>
</source>
</via>
<allow_attachments>true</allow_attachments>
<updated_at>2025-02-07T00:47:27Z</updated_at>
<problem_id/>
<follower_ids/>
<due_at/>
<id>69947</id>
<generated_timestamp>1738888005</generated_timestamp>
<assignee_id/>
<raw_subject>My laptop is broken</raw_subject>
<forum_topic_id/>
<custom_fields>
<id>1900001016587</id>
<value/>
</custom_fields>
<custom_fields>
<id>5313441454221</id>
<value/>
</custom_fields>
<allow_channelback>false</allow_channelback>
<satisfaction_rating>
<score>unoffered</score>
</satisfaction_rating>
<submitter_id>363369298572</submitter_id>
<priority/>
<collaborator_ids/>
<url>https://d3v-infacloud.zendesk.com/api/v2/tickets/69947.json</url>
<tags/>
<brand_id>360000485092</brand_id>
<ticket_form_id>360000143632</ticket_form_id>
<sharing_agreement_ids/>
<group_id/>
<organization_id>360044286132</organization_id>
<followup_ids/>
<recipient/>
<is_public>true</is_public>
<has_incidents>false</has_incidents>
<fields>
<id>1900001016587</id>
<value/>
</fields>
<status>new</status>
<requester_id>363369298572</requester_id>
</ticket>
</root>