End Users

This endpoint allows end users to make updates to their Zendesk Support profile.

JSON Format for End-user Requests

When an end-user makes the request, the user is returned with the following attributes:

Name Type Read-only Mandatory Comment
id integer yes no Automatically assigned when creating users
email string no no The primary email address of this user
name string no yes The name of the user
created_at date yes no The time the user was created
locale string yes no The locale for this user
locale_id integer no no The language identifier for this user
organization_id integer no no The id of the organization this user is associated with
phone string no no The primary phone number of this user. See Phone Number above
photo Attachment no no The user's profile picture represented as an Attachment object
role string no no The role of the user. Possible values: "end-user", "agent", "admin"
time_zone string no no The time-zone of this user
updated_at date yes no The time of the last update of the user
url string yes no The API url of this user
verified boolean no no Zendesk Support has verified that this user is who he says he is
Example
{
  "id":                    35436,
  "url":                   "https://company.zendesk.com/api/v2/end_users/35436.json",
  "name":                  "Johnny End User",
  "created_at":            "2009-07-20T22:55:29Z",
  "updated_at":            "2011-05-05T10:38:52Z",
  "time_zone":             "Copenhagen",
  "email":                 "johnny@example.com",
  "phone":                 "+1 555-123-4567",
  "locale":                "en-US",
  "locale_id":             1,
  "organization_id":       57542,
  "role":                  "end-user",
  "verified":              true,
  "photo": {
    "id":           928374,
    "name":         "my_funny_profile_pic.png",
    "content_url":  "https://company.zendesk.com/photos/my_funny_profile_pic.png",
    "content_type": "image/png",
    "size":         166144,
    "thumbnails": [
      {
        "id":           928375,
        "name":         "my_funny_profile_pic_thumb.png",
        "content_url":  "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",
        "content_type": "image/png",
        "size":         58298,
      }
    ]
  }
}

Show User

GET /api/v2/end_users/{id}.json

Allowed For:
  • End Users
Using curl:
curl https://{subdomain}.zendesk.com/api/v2/end_users/{id}.json \
  -v -u {email_address}:{password}
Example Response
Status: 200

{
  "user": {
    "id":   35436,
    "name": "Johnny End User",
    ...
  }
}

Update User

PUT /api/v2/end_users/{id}.json

Allowed For
  • End Users
Using curl
curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/api/v2/end_users/{id}.json \
  -H "Content-Type: application/json" -X PUT -d '{"user": {"name": "Roger Wilco II"}}'
Example Response
Status: 200 OK

{
  "user": {
    "id":   9873843,
    "name": "Roger Wilco II",
    ...
  }
}