Bookmarks

Bookmarks are API resources. The Zendesk Support user interface does not have a bookmarking feature.

JSON Format

Bookmarks are represented by flat JSON objects with the following properties.

Name Type Read-only Mandatory Comment
id integer yes n/a Automatically assigned when the bookmark is created
url string yes n/a The API url of this bookmark
ticket object yes n/a An object containing the properties of the bookmarked ticket
created_at date yes n/a The time the bookmark was created
Example
{
  "id":     35436,
  "url":    "https://company.zendesk.com/api/v2/bookmarks/35436.json",
  "ticket": {
    "id":           60,
    "subject":      "Help, my printer is on fire!",
    "description":  "The fire is very colorful.",
    "priority":     "high",
    ...
  },
  "created_at": "2014-11-20T22:55:29Z"
}

List Bookmarks

GET /api/v2/bookmarks.json

Allowed For:
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/bookmarks.json \
  -v -u {email_address}:{password}
Example Response
Status: 200 OK

{
  "bookmarks": [
    {
      "id":              35436,
      "created_at":      "2012-03-20T22:55:29Z",
      "ticket":          { ...}
    },
    {
      "id":              38416,
      "created_at":      "2012-03-21T12:22:18Z",
      "ticket":          { ...}
    }
  ]
}

Create Bookmark

POST /api/v2/bookmarks.json

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/bookmarks.json \
  -H "Content-Type: application/json" -X POST -d '{"bookmark": {"ticket_id": 123}}' \
  -v -u {email_address}:{password}
Example Response
Status: 201 Created
Location: https://{subdomain}.zendesk.com/api/v2/bookmarks/{id}.json

{
  "bookmark": {
    "id":              44215,
    "created_at":      "2012-03-21T04:31:29Z",
    "ticket":          { ... }
  }
}

If the bookmark already exists with the specified ticket_id the response will be http Status: 200 OK

Delete Bookmark

DELETE /api/v2/bookmarks/{id}.json

Allowed For
  • Agents (own bookmarks only)
Using curl
curl https://{subdomain}.zendesk.com/api/v2/bookmarks/{id}.json \
  -X DELETE -v -u {email_address}:{password}
Example Response
Status: 204 No Content