Zendesk Support Field Reference


This connector fetches data from Zendesk on a support case level.





allow_attachmentsBOOLEANAllow AttachmentsPermission for agents to add add attachments to a comment. Defaults to true.
allow_channelbackBOOLEANAllow ChannelbackIs false if channelback is disabled, true otherwise. Only applicable for channels framework ticket.
assignee_emailTEXTAssignee EmailWrite only. The email address of the agent to assign the ticket to.
assignee_idTEXTAssignee IdThe agent currently assigned to the ticket.
attribute_value_idsTEXTAttribute Value IdsWrite only. An array of the IDs of attribute values to be associated with the ticket.
brand_idTEXTBrand IdEnterprise only. The id of the brand this ticket is associated with.
collaborator_idsTEXTCollaborator IdsThe ids of users currently CC'ed on the ticket.
collaboratorsTEXTCollaboratorsPOST requests only. Users to add as cc's when creating a ticket.
commentTEXTCommentWrite only. An object that adds a comment to the ticket.
created_atDATECreated AtWhen this record was created.
custom_fieldsTEXTCustom FieldsCustom fields for the ticket.
custom_status_idTEXTCustom Status IdThe custom ticket status id of the ticket.
dateDATEDateAlias for Created At.
descriptionTEXTDescriptionRead-only first comment on the ticket. When creating a ticket, use comment to set the description.
due_atDATEDue AtIf this is a ticket of type task it has a due date.
email_cc_idsTEXTEmail cc IdsThe ids of agents or end users currently CC'ed on the ticket.
email_ccsTEXTEmail ccsWrite only. An array of objects that represent agent or end users email CCs to add or delete from the ticket.
external_idTEXTExternal IdAn id you can use to link Zendesk Support tickets to local records.
follower_idsTEXTFollower IdsThe ids of agents currently following the ticket.
followersTEXTFollowersWrite only. An array of objects that represent agent followers to add or delete from the ticket.
followup_idsTEXTFollowup IdsThe ids of the followups created from this ticket. Ids are only visible once the ticket is closed.
forum_topic_idTEXTForum Topic IdThe topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated.
group_idTEXTGroup IdThe group this ticket is assigned to.
has_incidentsBOOLEANHas IncidentsIs true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false.
idTEXTIDAutomatically assigned when the ticket is created.
is_publicBOOLEANIs PublicIs true if any comments are public, false otherwise.
macro_idTEXTMacro IdWrite only. A macro ID to be recorded in the ticket audit.
macro_idsTEXTMacro IdsPOST requests only. List of macro IDs to be recorded in the ticket audit.
metadataTEXTMetadataWrite only. Metadata for the audit. In the audit object, the data is specified in the custom property of the metadata object.
organization_idTEXTOrganization IdThe organization of the requester. You can only specify the ID of an organization associated with the requester.
priorityTEXTPriorityThe urgency with which the ticket should be addressed. Allowed values are urgent, high, normal, or low.
problem_idTEXTProblem IdFor tickets of type incident, the ID of the problem the incident is linked to.
raw_subjectTEXTRaw SubjectThe dynamic content placeholder, if present, or the subject value, if not.
recipientTEXTRecipientThe original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address.
requesterTEXTRequesterWrite only.
requester_idTEXTRequester IdThe user who requested this ticket.
safe_updateBOOLEANSafe UpdateWrite only. Optional boolean. Prevents updates with outdated ticket data (updated_stamp property required when true).
satisfaction_ratingTEXTSatisfaction RatingThe satisfaction rating of the ticket, if it exists, or the state of satisfaction, offered or unoffered. The value is null for plan types that don't support CSAT.
sharing_agreement_idsTEXTSharing Agreement IdsThe ids of the sharing agreements used for this ticket.
statusTEXTStatusThe state of the ticket. Allowed values are new, open, pending, hold, solved, or closed.
subjectTEXTSubjectThe value of the subject field for this ticket.
submitter_idTEXTSubmitter IdThe user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.
tagsOBJECTTagsThe array of tags applied to this ticket.
ticket_form_idTEXTTicket Form IdEnterprise only. The id of the ticket form to render for the ticket.
typeTEXTTypeThe type of this ticket. Allowed values are problem, incident, question, or task.
updated_atDATEUpdated AtWhen this record last got updated.
updated_stampDATEUpdated StampWrite only. Datetime of last update received from API.
urlTEXTURLThe API url of this ticket.
viaTEXTViaFor more information, see the Via object reference
via_followup_source_idTEXTVia Followup Source IdPOST requests only. The id of a closed ticket when creating a follow-up ticket.
via_idTEXTVia IdFor more information, see the Via object reference
voice_commentTEXTVoice CommentWrite only. See Creating voicemail ticket.