Meta tags:
description=Developer documentation for products at Zendesk;

Headings (most frequently used words):

using, curl, badge, allowed, for, example, response, help, center, badges, on, this, page, icon, upload, api, federated, search, employee, services, templates, json, format, list, show, create, request, url, update, delete, parameters,

Text of the page (most frequently used words):
the (69), badge (52), badges (27), icon (22), page (22), api (20), content (18), amz (18), #request (17), url (17), community (16), gather (16), help (15), curl (14), center (14), upload (14), type (12), name (12), https (11), description (11), image (11), string (11), zendesk (10), using (9), post (9), com (8), for (8), 2020 (8), 000z (8), allowed (7), badge_category_id (7), icon_url (7), svg (7), yes (7), response (6), password (6), email_address (6), subdomain (6), managers (6), json (6), put (6), from (6), badge_icon_upload (6), icon_upload_id (6), headers (6), 01eyv0kr9ea8vgfmfdmekpt15c (6), server (6), side (6), encryption (6), object (6), 13t11 (6), list (6), status (5), example (5), delete (5), superhero (5), saving (5), day (5), with (5), update (5), when (5), create (5), updated_at (5), created_at (5), user (5), uploaded (4), disposition (4), aes256 (4), xml (4), specified (4), created (4), following (4), 01e86xpm9459s78f83vh8cd69h (4), show (4), categories (4), search (4), article (4), developer (3), assignments (3), that (3), application (3), value (3), new (3), null (3), expires (3), properties (3), signed (3), 01e86xpprdcnhytsvwsrmd76r0 (3), this (3), format (3), are (3), upgrading (3), templating (3), templates (3), external (3), all (2), base64 (2), based (2), mechanism (2), involving (2), has (2), been (2), deprecated (2), send (2), while (2), setting (2), step (2), provided (2), attached (2), omit (2), have (2), set (2), aus (2), assets (2), production (2), amazonaws (2), 1749971 (2), 2fsvg (2), 2bxml (2), algorithm (2), aws4 (2), hmac (2), sha256 (2), credential (2), akiayspzoxopsgbvqtma (2), 2f20210218 (2), 2fus (2), east (2), 2fs3 (2), 2faws4_request (2), date (2), 20210218t164716z (2), 3600 (2), signature (2), 0d297b81820ffe8b609e0f801e73eb5a62b6a6108cd076d26a378a3a22e5efde (2), signedheaders (2), 3bhost (2), 3bx (2), attachment (2), filename (2), property (2), content_type (2), file_size (2), icon_uploads (2), integer (2), types (2), header (2), pre (2), returns (2), 200 (2), information (2), about (2), get (2), 14t11 (2), brand (2), query (2), brand_id (2), can (2), only (2), was (2), timestamp (2), category (2), profile (2), custom (2), topic (2), service (2), catalog (2), home (2), objects (2), helpers (2), introduction (2), subscriptions (2), comments (2), zendev_horizontal (2), system, terms, privacy, notice, 181, fremont, street, 17th, floor, san, francisco, california, 94105, slack, blog, forum, join, our, 204, deleting, also, deletes, pertain, leave, existing, unchanged, not, path, your, uploads, local, location, returned, endpoint, append, path_to_icon, 201, 420000, size, bytes, png, jpeg, gif, body, takes, containing, key, pairs, must, included, uploading, aws, where, will, separate, one, hour, after, identifying, used, later, creating, updating, consisting, without, you, shows, single, clever, answers, difficult, questions, smart, cookie, 01e89dz2na6zpmbmrpfrxc2bry, false, required, parameters, further, filtered, parameter, within, particular, lists, last, updated, may, empty, automatically, assigned, comment, mandatory, read, available, professional, plan, organized, different, and, linked, users, reward, added, more, see, error, approval, results, contributions, section, footer, advanced, items, employee, services, sources, records, federated, redirect, rules, account, claims, jwts, tags, guide, media, images, votes, segments, posts, topics, themes, translations, management, permission, groups, sessions, sections, labels, attachments, articles, reference, documentation, docs,

Text of the page (random words):
badges zendesk developer docs zendev_horizontal zendev_horizontal documentation api reference search help center help center api home help center help center help center api articles article attachments article comments article labels categories search sections sessions management permission groups translations themes topics posts post comments content subscriptions user subscriptions user segments votes badges badge assignments badge categories user images guide media objects content tags help center jwts account custom claims redirect rules federated search introduction external content records external content sources external content types employee services service catalog items help center templates introduction helpers advanced helpers objects header footer home page category page section page article page contributions page following page request list page request page new request page search results page service catalog page templates approval request page templates error page new community post page community post page community post list page community topic page community topic list page user profile page custom page upgrading from templating api v1 upgrading from templating api v2 upgrading from templating api v3 on this page json format list badges show badge create badge request badge icon upload url upload badge icon update badge delete badge badges on this page json format list badges show badge create badge request badge icon upload url upload badge icon update badge delete badge a badge is a reward that can be added to a user s profile in the help center for more information see about gather badges in zendesk help badges are organized by different badge categories and are linked to users using badge assignments badges are available on the gather professional plan json format badges have the following properties name type read only mandatory comment id string yes no automatically assigned when the badge is created badge_category_id string yes yes the id of the badge category of the badge name string no yes the name of the badge description string no yes the description of the badge may be an empty string icon_url string no no the url of the badge s icon created_at timestamp yes no when the badge was created updated_at timestamp yes no when the badge was last updated example id 01e86xpprdcnhytsvwsrmd76r0 badge_category_id 01e86xpm9459s78f83vh8cd69h name community superhero description saving the day in the community icon_url https created_at 2020 05 13t11 46 19 000z updated_at 2020 05 13t11 46 19 000z list badges get api v2 gather badges lists all badges this request can be further filtered using the brand_id query string parameter to only show badge categories within a particular brand parameters name type in required description brand_id integer query false returns the badges for the specified brand allowed for help center managers using curl curl https subdomain zendesk com api v2 gather badges v u email_address password example response status 200 ok badges id 01e86xpprdcnhytsvwsrmd76r0 badge_category_id 01e86xpm9459s78f83vh8cd69h name community superhero description saving the day in the community icon_url https created_at 2020 05 13t11 46 19 000z updated_at 2020 05 13t11 46 19 000z id 01e89dz2na6zpmbmrpfrxc2bry badge_category_id 01e86xpm9459s78f83vh8cd69h name smart cookie description clever answers to difficult questions icon_url null created_at 2020 05 14t11 08 59 000z updated_at 2020 05 14t11 08 59 000z show badge get api v2 gather badges id shows information about a single badge allowed for help center managers using curl curl https subdomain zendesk com api v2 gather badges id v u email_address password example response status 200 ok badge id 01e86xpprdcnhytsvwsrmd76r0 badge_category_id 01e86xpm9459s78f83vh8cd69h name community superhero description you re saving the day in the community icon_url https created_at 2020 05 13t11 46 19 000z updated_at 2020 05 13t11 46 19 000z create badge post api v2 gather badges to create a badge without an icon omit icon_upload_id or set it to null to create a badge with an icon request a badge icon upload url upload the icon to the provided url with the attached headers send the post api v2 gather badges request while setting the icon_upload_id to the value of badge_icon_upload id from the response of step 1 the base64 based upload mechanism involving icon_url has been deprecated allowed for help center managers using curl curl https subdomain zendesk com api v2 gather badges d badge badge_category_id name community superhero description saving the day in the community icon_upload_id 01eyv0kr9ea8vgfmfdmekpt15c v u email_address password x post h content type application json request badge icon upload url post api v2 gather badges icon_uploads returns a badge_icon_upload object consisting of the following properties name type description id string a string identifying the badge icon upload used later when creating or updating a badge url string a pre signed aws s3 url where the badge icon will be uploaded in a separate request the url expires one hour after it s created headers object an object containing the signed header key value pairs that must be included in the request to the pre signed s3 url when uploading the badge icon the request body takes an object with the following properties name type description content_type string the content type of badge icon to be uploaded allowed types image svg xml image png image jpeg or image gif file_size integer the badge icon size in bytes allowed for help center managers using curl curl https subdomain zendesk com api v2 gather badges icon_uploads v u email_address password d content_type image svg xml file_size 420000 x post h content type application json example response status 201 created badge_icon_upload id 01eyv0kr9ea8vgfmfdmekpt15c url https aus uploaded assets production s3 amazonaws com 26 1749971 01eyv0kr9ea8vgfmfdmekpt15c content type image 2fsvg 2bxml x amz algorithm aws4 hmac sha256 x amz credential akiayspzoxopsgbvqtma 2f20210218 2fus east 1 2fs3 2faws4_request x amz date 20210218t164716z x amz expires 3600 x amz signature 0d297b81820ffe8b609e0f801e73eb5a62b6a6108cd076d26a378a3a22e5efde x amz signedheaders content disposition 3bhost 3bx amz server side encryption x amz server side encryption aes256 headers content disposition attachment filename 01eyv0kr9ea8vgfmfdmekpt15c svg content type image svg xml x amz server side encryption aes256 upload badge icon put path_to_icon uploads the specified local image to the location specified by the url returned by the request badge icon upload url endpoint the url is specified in the url property of the badge_icon_upload object append the headers from the headers property of the badge_icon_upload object to the put request using curl curl x put t path to your image svg h content type image svg xml h content disposition attachment filename 01eyv0kr9ea8vgfmfdmekpt15c svg h x amz server side encryption aes256 l https aus uploaded assets production s3 amazonaws com 26 1749971 01eyv0kr9ea8vgfmfdmekpt15c content type image 2fsvg 2bxml x amz algorithm aws4 hmac sha256 x amz credential akiayspzoxopsgbvqtma 2f20210218 2fus east 1 2fs3 2faws4_request x amz date 20210218t164716z x amz expires 3600 x amz signature 0d297b81820ffe8b609e0f801e73eb5a62b6a6108cd076d26a378a3a22e5efde x amz signedheaders content disposition 3bhost 3bx amz server side encryption x amz server side encryption aes256 update badge put api v2 gather badges id to update a badge not to have an icon set icon_upload_id to null to leave the existing icon unchanged omit icon_upload_id to update a badge with a new icon request a badge icon upload url upload the icon to the provided url with the attached headers send the put api v2 gather badges id request while setting the icon_upload_id to the value of badge_icon_upload id from the response of step 1 the base64 based upload mechanism involving icon_url has been deprecated allowed for help center managers using curl curl https subdomain zendesk com api v2 gather badges id v u email_address password d badge badge_category_id name community superhero description saving the day in the community x put h content type application json delete badge delete api v2 gather badges id deleting a badge also deletes all badge assignments that pertain to the badge allowed for help center managers using curl curl https subdomain zendesk com api v2 gather badges id v u email_address password x delete example response status 204 no content join our developer community forum blog slack zendesk 181 fremont street 17th floor san francisco california 94105 privacy notice zendesk developer terms system status