Meta tags:
description= Developer documentation for products at Zendesk;
Headings (most frequently used words):
returns, get, ticket, set, invoke, object, ticketfield, comment, copilot, events, brand, autoassist, ticketfieldoption, channel, macro, apps, field, change, attachment, id, name, api, user, agreement, via, label, changed, form, save, status, type, isactive, optionvalues, index, the, by, supported, on, this, page, event, collision, submission, hook, comments, description, isvisible, isenabled, disable, enable, hide, show, toggle, macros, autoassistmessage, autoassisttranslation, upcomingmessage, action, to, limitations, all, and, new, sidebar, core, support, chat, sell, sharing, messaging, capabilities, option, auto, assist, custom, wildcard, updated, assignee, collaborators, conversation, customfield, fieldname, customstatus, createdat, editor, emailccs, externalid, followers, isnew, organization, postsaveaction, priority, recipient, requester, sendmessage, sharedwith, statuscategory, subject, tags, argument, updatedat, viewers, disablesave, enablesave, sessionbased, sessionactive, attachments, text, userichtext, appendhtml, appendmarkdown, appendtext, contenttype, contenturl, filename, thumbnailurl, hashelpcenter, isdefault, logo, subdomain, url, isediting, isidle, partnername, messagingcapabilities, richtext, ticketfields, optiongroups, isrequired, requiredonstatuses, identifier, value, availabilitytype, title, source, notifycopilot, upcomingmessagetranslation, approve, allowing, proceed, preventing, from, proceeding, notifying, if, is, not, saved, resolving, conflicts, when, multiple, respond, global, timeout, using, specifications, fields, arguments, example, names, author, roles, message, content, types,
Text of the page (most frequently used words):
ticket (506), the (429), get (213), client (206), object (140), #returns (123), #ticketfields (85), comment (82), and (77), properties (75), set (74), user (71), copilot (68), changed (68), invoke (64), value (63), string (60), event (58), identifier (58), for (57), channel (56), can (51), field (50), agent (49), autoassist (48), events (47), brand (47), status (46), you (44), optionvalues (42), name (42), save (41), text (39), type (37), see (34), app (33), example (33), when (32), message (32), this (30), that (30), ticketfield (30), custom (29), label (28), assignee (28), from (27), following (27), messaging (27), are (26), zendesk (25), api (25), macro (25), hook (24), via (24), sidebar (23), form (23), change (23), end (22), apps (22), attachment (21), action (20), ticketfieldoption (19), use (19), option (19), followers (19), messages (18), html (18), new (17), with (17), values (17), one (17), tags (17), comments (17), attachments (17), email (17), customfield (17), also (16), auto (16), boolean (16), macros (16), fieldname (16), all (15), available (15), only (15), agreement (15), editor (15), function (15), public (15), group (14), note (14), fields (14), optiongroups (14), chat (14), property (13), assist (13), not (13), description (13), index (13), requester (13), sharedwith (13), support (13), add (13), admin (13), handler (13), actions (12), web (12), priority (12), remove (12), collaborators (12), has (11), changes (11), isactive (11), open (11), organization (11), sharing (11), viewers (11), contenttype (11), plain (11), emailccs (11), then (10), promise (10), autoassistmessage (10), may (10), your (10), customstatus (10), translation (9), upcomingmessage (9), using (9), specified (9), isvisible (9), isenabled (9), specify (9), collision (9), conversations (9), updated (9), statuscategory (9), return (8), asynchronous (8), autoassisttranslation (8), content (8), number (8), submit (8), objects (8), other (8), task (8), data (8), list (8), ccs (8), externalid (8), fires (8), wildcard (8), error (7), false (7), current (7), location (7), show (7), more (7), was (7), integer (7), pending (7), hold (7), solved (7), due_date (7), enabled (7), null (7), help (7), author (7), pass (7), workspace (7), conversation (7), social (7), parameter (7), subject (7), listen (7), approve (6), occurs (6), displayed (6), respond (6), about (6), toggle (6), hide (6), enable (6), disable (6), date (6), statuses (6), any (6), problem (6), addition (6), url (6), filename (6), contenturl (6), these (6), saved (6), supported (6), setting (6), facebook (6), such (6), problem_id (6), incident (6), triggers (6), sendmessage (6), recipient (6), permissions (6), groupid (6), something (6), after (5), upcoming (5), translating (5), must (5), language (5), will (5), upcomingmessagetranslation (5), contains (5), used (5), notifycopilot (5), default (5), which (5), source (5), title (5), placeholder (5), refer (5), instead (5), requiredonstatuses (5), isrequired (5), options (5), messagingcapabilities (5), richtext (5), rich (5), capabilities (5), isidle (5), isediting (5), time (5), limits (5), postsaveaction (5), widget (5), classic (5), submission (5), handlers (5), allow (5), proceed (5), notification (5), responsive (5), page (5), system (4), notice (4), returned (4), handle (4), panel (4), update (4), agents (4), kind (4), bar (4), errors (4), framework (4), information (4), created (4), examples (4), have (4), availabilitytype (4), access (4), individual (4), their (4), zero (4), indexed (4), order (4), named (4), where (4), period (4), limitations (4), array (4), possible (4), custom_field_1234 (4), custom_field_ (4), specifies (4), partnername (4), subdomain (4), logo (4), isdefault (4), hashelpcenter (4), doesn (4), thumbnailurl (4), appendhtml (4), userichtext (4), sessionactive (4), currently (4), session (4), sessionbased (4), based (4), two (4), whatsapp (4), 8601 (4), iso (4), updatedat (4), due (4), var (4), value2 (4), value1 (4), argument (4), category (4), case (4), isnew (4), createdat (4), call (4), line (4), userid (4), request (4), another (4), newvalue (4), propertyname (4), locations (4), iframe (4), developer (3), async (3), useful (3), approval (3), until (3), right (3), before (3), way (3), what (3), provides (3), being (3), sent (3), state (3), original (3), trigger (3), functionality (3), valid (3), completed (3), they (3), should (3), details (3), rest (3), some (3), channels (3), how (3), headings (3), actual (3), colon (3), multiple (3), occur (3), tickets (3), methods (3), appendtext (3), appendmarkdown (3), css (3), formatting (3), during (3), synchronous (3), live (3), between (3), but (3), last (3), internal (3), enablesave (3), disablesave (3), viewing (3), formatted (3), characters (3), existing (3), activating (3), hello (3), world (3), next (3), stay (3), view (3), configuring (3), settings (3), twitter (3), wechat (3), private (3), direct (3), supply (3), manifest (3), interface (3), proceeding (3), true (3), triggered (3), run (3), receives (3), been (3), updates (3), always (3), handlechange (3), underlying (3), want (3), core (3), flexible (3), background (3), introduction (3), terms (2), behavior (2), similar (2), resolving (2), approving (2), process (2), rejected (2), shown (2), performed (2), immediately (2), blocked (2), returning (2), suggestion (2), arrives (2), suggestions (2), subsequent (2), read (2), manually (2), usually (2), visible (2), translated (2), comes (2), replace (2), different (2), than (2), behalf (2), indicates (2), related (2), define (2), mode (2), provided (2), optional (2), causes (2), clear (2), loading (2), notify (2), apis (2), work (2), under (2), documentation (2), mobile (2), same (2), effect (2), availability (2), separator (2), categories (2), built (2), strings (2), required (2), listed (2), requirements (2), 10007 (2), dropdown (2), inverse (2), urgent (2), names (2), don (2), whether (2), supports (2), shared (2), reference (2), represents (2), including (2), match (2), rules (2), twitterreply (2), twitterdirectmessage (2), publicreply (2), internalnote (2), facebookwallreply (2), facebookprivatemessage (2), targetchannel (2), into (2), syntax (2), defined (2), real (2), who (2), include (2), talk (2), could (2), transacted (2), ignored (2), linked (2), question (2), retrieve (2), make (2), fetch (2), types (2), role (2), chat_transcript (2), any_channel (2), instagram_dm (2), sunshine_conversations_facebook_messenger (2), sunshine_conversations_twitter_dm (2), native_messaging (2), voicemail (2), voice (2), transcript (2), messenger (2), legacy (2), log (2), parameters (2), assign (2), within (2), fail (2), global (2), timeout (2), canceled (2), while (2), file (2), reject (2), meaning (2), display (2), side (2), notifying (2), needs (2), ajax (2), first (2), determine (2), working (2), code (2), start (2), lifecycle (2), track (2), fire (2), assets (2), width (2), tray (2), good (2), submitted (2), modal (2), top (2), zendev_horizontal (2), privacy, 181, fremont, street, 17th, floor, san, francisco, california, 94105, slack, blog, forum, join, our, community, approach, blocking, fetched, waits, arrive, continue, growl, callback, unblocked, already, edited, staged, dedicated, area, separate, main, initiate, those, translate, back, prior, happen, reflects, becomes, stored, part, later, applied, uses, reverse, needed, rephrase, active, moment, exposes, accommodate, activities, shows, exposed, spinning, icon, indicating, ongoing, specifying, notifications, cleared, warning, arguments, posts, info, warnings, generated, targeting, gives, why, 123, invoking, were, select, everyone, personal, alternatively, toggling, alternating, hidden, textarea, tagger, regexp, decimal, checkbox, conditional, here, expandable, selectable, ones, expand, associated, organizations, enterprise, ticket_form_id, collaborator, either, partner, managed, agreements, accounts, regular, well, nonimageattachments, imageattachments, team, washed, phone, warm, soapy, water, now, audits, image, goes, through, sanitizer, normalizer, security, reasons, involves, removing, most, affects, table, partially, recommend, transpiles, markdown, communication, involve, parties, simultaneously, participating, non, refers, featuring, ticketing, drive, experience, depending, immediacy, reporting, analytics, purposes, etc, notes, create, represented, 2020, problemid, taskdue, 5096, aggregate, 255, value3, sending, sure, check, omitted, send, sends, works, address, high, normal, low, happens, guided, close, tab, external, format, endpoint, custom_statuses, json, 671172, find, invalid, setter, center, its, recordings, included, bot, roles, integrations, instagram, formerly, recording, specifications, yyyy, ddthh, ssz, timestamp, avatar, lightweight, version, 65k, editing, online, transferred, newly, assigned, belong, otherwise, disabled, composition, his, her, because, never, seconds, disallows, tries, third, apply, conflicts, jennifer, hansen, sinker, along, disallowed, method, wasn, styled, persistent, dismisses, cancels, box, upper, halt, operation, cancelled, below, stop, general, preventing, resolved, proceeds, allowing, prevent, affect, ways, decide, clicks, button, presses, keyboard, shortcut, product, block, completion, responds, viewer, listening, allows, logged, made, saves, concurrent, avoiding, collisions, receive, regardless, success, failure, failed, responding, successfully, done, initiated, haven, yet, correspond, controlled, dynamic, identifying, handling, installed, protected, special, specific, 123123, custom_field_123123, whenever, remember, relate, specifically, listened, mean, fully, loaded, ready, manipulated, cases, underscore, helper, defer, respective, interaction, listeners, additional, new_ticket_sidebar, ticket_sidebar, recommended, aren, fixed, 320px, assumed, automatically, resizes, designing, idea, follow, best, practices, regarding, design, adjust, positioning, elements, roughly, would, like, them, there, frameworks, solve, materialize, tailwind, once, even, visit, composer, person, lead, deal, company, sell, nav, zaf, home, search, docs,
Text of the page (random words):
get ticket requester set client set ticket requester email value1 name value2 name is optional or client set ticket requester id value returns ticket requester user object properties see user object properties ticket sendmessage sends a message to the end user on behalf of the agent only works during live chat and messaging conversations for the messaging channel you can specify a contenttype option which indicates the formatting of the content valid values are text plain and text html if omitted the default value is text plain if contenttype is specified as text html apps can send html messages see about rich text formatting in messaging conversations before sending html messages make sure the messaging channel supports rich text messaging to check for rich text capabilities use the ticket messagingcapabilities richtext api invoke client invoke ticket sendmessage channel value1 message value2 contenttype value3 example client invoke ticket sendmessage channel chat message hello world example client invoke ticket sendmessage channel messaging message hello world example client invoke ticket sendmessage channel messaging message hello b world b contenttype text html ticket sharedwith the ticket shared agreement get client get ticket sharedwith set client set ticket sharedwith id value returns ticket sharedwith sharing agreement object properties see sharing agreement object properties ticket status the ticket status get client get ticket status set for a new ticket you can pass in one of the following values new open pending hold and solved for an existing ticket you can pass in one of the following values open pending hold and solved note activating a custom ticket status triggers a ticket customstatus changed event setting a custom ticket status may also change the ticket s status category in this case the change also triggers a ticket statuscategory changed event client set ticket status value returns ticket status string ticket statuscategory the ticket status category note activating a custom ticket status triggers a ticket customstatus changed event setting a custom ticket status may also change the ticket s status category in this case the change also triggers a ticket statuscategory changed event get client get ticket statuscategory set for a new ticket you can pass in one of the following values new open pending hold or solved for an existing ticket you can pass in one of the following values open pending hold or solved client set ticket statuscategory value returns ticket statuscategory string ticket subject the ticket subject get client get ticket subject set client set ticket subject value limits 255 characters returns ticket subject string ticket tags the list of tags on the ticket get client get ticket tags set client set ticket tags values argument values an array of tags strings returns ticket tags string limits 5096 characters for all tags in aggregate invoke client invoke ticket tags add value or client invoke ticket tags add value1 value2 invoke client invoke ticket tags remove value or client invoke ticket tags remove value1 value2 ticket type the ticket type get returns one of the following values question incident problem or task client get ticket type if the type is task you can retrieve the task s due date if any with the ticket customfield fieldname api specify due_date as the fieldname parameter client get ticket type then function data if data ticket type task client get ticket customfield due_date then function data var taskdue data ticket customfield due_date if the type is incident you can retrieve the id of the linked problem ticket if any with the ticket customfield fieldname api specify problem_id as the fieldname parameter client get ticket type then function data if data ticket type incident client get ticket customfield problem_id then function data var problemid data ticket customfield problem_id set you can pass in one of the following values question incident problem or task client set ticket type value if you set the type to task you can set the task s due date with the ticket customfield fieldname api specify due_date as the fieldname parameter client set ticket type task ticket customfield due_date 2020 02 30 returns ticket type string if you set the type to incident you can set the id of the linked problem ticket with the ticket customfield fieldname api specify problem_id as the fieldname parameter client set ticket type incident ticket customfield problem_id 78 ticket updatedat when the ticket was last updated get client get updatedat returns ticket updatedat iso 8601 formatted date time ticket via channel used to create the ticket such as email api or web the channel is represented as a via object get client get ticket via returns ticket via via object properties see via object properties ticket viewers other agents viewing the current ticket get client get ticket viewers returns ticket viewers collision user object properties see collision user object properties disablesave invoke client invoke disablesave enablesave invoke client invoke enablesave channel object this object contains details of the channel based on the last transacted message between an end user and an agent agent to agent conversations such as internal notes are ignored channel get client get channel returns ticket channel object properties properties channel name channel sessionbased channel sessionactive channel name get client get channel name returns channel name string email chat web facebook whatsapp etc this property should only be used for reporting and analytics purposes channel sessionbased specifies if the channel is asynchronous or synchronous this property could be used to drive agent experience functionality in a zendesk support app depending on the immediacy of the channel that the agent is using session based messaging is defined as communication channels that involve real time conversations between two parties who are simultaneously participating example of session based messaging include zendesk chat and zendesk talk conversations non session based messaging refers to channels featuring conversations that can occur in real time but are usually asynchronous examples include email social messaging or web form ticketing get client get channel sessionbased returns channel sessionbased boolean channel sessionactive if the current channel of the editor is synchronous then this property specifies if the channel is currently in a live session or not get client get channel sessionactive returns channel sessionactive boolean comment object comment get client get comment returns comment comment object properties properties comment attachments comment text comment type comment userichtext actions comment appendhtml comment appendmarkdown comment appendtext comment attachments get client get comment attachments returns comment attachments comment attachment object properties see comment attachment object properties comment text get client get comment text set client set comment text value returns comment text string in the zendesk agent workspace setting comment text during a chat conversation auto transpiles rich text into plain text markdown syntax in the chat editor comment type note in the zendesk agent workspace comment type is only partially supported we recommend using ticket editor targetchannel instead get returns facebookprivatemessage facebookwallreply internalnote publicreply twitterdirectmessage or twitterreply client get comment type set you can pass in one of the following values facebookprivatemessage facebookwallreply internalnote publicreply twitterdirectmessage twitterreply client set comment type value returns comment type string comment userichtext get client get comment userichtext returns comment userichtext boolean comment appendhtml note when using comment appendhtml html comments goes through a html sanitizer and normalizer for security reasons and to match the html rules for the ticket editor this involves removing most css and some html tags which affects table formatting invoke client invoke comment appendhtml value returns errors comment appendmarkdown invoke client invoke comment appendmarkdown value returns errors comment appendtext invoke client invoke comment appendtext value returns errors comment attachment object the comment attachment object represents ticket comment attachments it has the following properties properties attachment contenttype attachment contenturl attachment filename attachment thumbnailurl note the headings use a placeholder named attachment to refer to the attachment object this is not an actual object name attachment contenttype get client get comment attachments 0 contenttype returns comment attachments 0 contenttype string attachment contenturl get client get comment attachments 0 contenturl returns comment attachments 0 contenturl string attachment filename get client get comment attachments 0 filename returns comment attachments 0 filename string attachment thumbnailurl only available when the attachment is an image get client get comment attachments 0 thumbnailurl returns comment attachments 0 thumbnailurl string comment event object represents saved comments from the ticket s audits including comment id value author and attachments comments get client get ticket comments returns ticket comments id 1 value hi support team i washed my phone with warm soapy water and now your app doesn t work author user object properties via via object properties imageattachments comment attachment object properties nonimageattachments comment attachment object properties see the user object and comment attachment object as well as the via object rest api for more information on these fields brand object properties brand hashelpcenter brand id brand isactive brand isdefault brand logo brand name brand subdomain brand url brand hashelpcenter get client get ticket brand hashelpcenter returns ticket brand hashelpcenter boolean brand id get client get brand id returns ticket brand id integer brand isactive get client get ticket brand isactive returns ticket brand isactive boolean brand isdefault get client get ticket brand isdefault returns ticket brand isdefault boolean brand logo get client get ticket brand logo returns ticket brand logo contenttype string contenturl string filename string brand name get client get ticket brand name returns ticket brand name string brand subdomain get client get ticket brand subdomain returns ticket brand subdomain string brand url get client get ticket brand url returns ticket brand url string collision user object the following properties are in addition to the methods provided by the regular user object properties user isediting user isidle user isediting get client get ticket viewers 0 isediting returns ticket viewers 0 isediting boolean user isidle client get ticket viewers 0 isidle returns ticket viewers 0 isidle boolean sharing agreement object a sharing agreement specifies the terms under which ticket sharing can occur and how shared tickets are managed see sharing tickets with other zendesk support accounts in zendesk help and sharing agreements in the api reference properties agreement id agreement name agreement partnername agreement id get client get ticket sharedwith 0 id returns ticket sharedwith 0 id integer agreement name get client get ticket sharedwith 0 name returns ticket sharedwith 0 name string agreement partnername the partner name may be null get client get ticket sharedwith 0 partnername returns ticket sharedwith 0 partnername string ticket messaging capabilities object properties messagingcapabilities richtext messagingcapabilities richtext specifies whether a messaging ticket supports rich text messaging get client get ticket messagingcapabilities richtext returns ticket messagingcapabilities richtext boolean ticket field object ticketfields returns either the named ticket field or all available ticket fields if you don t specify a name available ticket field names brand requester assignee collaborator ticket_form_id enterprise only tags type priority sharedwith if a ticket sharing agreement is enabled due_date organization if the requester is associated with multiple organizations problem status custom_field_ id for custom fields replace id with the custom field s id example custom_field_1234 get all fields client get ticketfields returns ticketfields ticket field object properties get field by name client get ticketfields fieldname for example client get ticketfields custom_field_1234 returns ticketfields fieldname ticket field object properties you can also access individual fields by their zero indexed order get field by index client get ticketfields 0 you must use a period instead of a colon to specify the index returns ticketfields 0 ticket field object properties a ticket field object has the following properties and actions properties ticketfield name ticketfield label ticketfield optionvalues ticketfield optiongroups ticketfield isrequired ticketfield requiredonstatuses ticketfield isvisible ticketfield isenabled ticketfield type status optionvalues index label status optionvalues identifier label actions ticketfield disable ticketfield enable ticketfield hide ticketfield show ticketfield toggle note the headings use a placeholder named ticketfield to refer to the ticket field object this is not an actual object name the examples refer to the ticket field object as ticketfields identifier where identifier is a placeholder for the field name or index number if the identifier is an index number the separator is a period instead of a colon example ticketfields 0 note you can t use ticketfield actions on custom ticket statuses in the ticketfields status options or ticketfields status optionvalues properties ticketfield name get client get ticketfields identifier name returns ticketfields identifier name string ticketfield label get client get ticketfields identifier label set client set ticketfields identifier label value returns ticketfields identifier label string ticketfield optionvalues if a value is specified returns the specified option object if no value is specified returns all the available option objects only available for dropdown fields this api only returns values that are selectable not the ones that expand to a group of other options the inverse of optiongroups get client get ticketfields identifier optionvalues client get ticketfields priority optionvalues returns ticketfields identifier optionvalues ticket field option object properties or get client get ticketfields identifier optionvalues value client get ticketfields priority optionvalues urgent returns ticketfields identifier optionvalues value ticket field option object properties you can also access individual options by their zero indexed order get client get ticketfields identifier optionvalues 0 client get ticketfields priority optionvalues 0 returns ticketfields identifier optionvalues 0 ticket field option o...
|
