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

JSON Format

End User are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
created_at string true false The time the user was created
email string false false The primary email address of this user
id integer true false Automatically assigned when creating users
locale string true false The locale for this user
locale_id integer false false The language identifier for this user
name string false true The name of the user
organization_id integer false false The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization. If updating, see Organization ID
phone string false false The primary phone number of this user. See Phone Number in the Users API
photo object false false A file represented as an Attachment Attachment object
role string false false The role of the user. Possible values: "end-user", "agent", or "admin"
shared_phone_number boolean true false Whether the phone number is shared or not. See Phone Number in the Users API
time_zone string false false The time-zone of this user
updated_at string true false The time of the last update of the user
url string true false The API url of this user
verified boolean false false The user's primary identity is verified or not. For secondary identities, see User Identities

Example

{  "created_at": "2009-07-20T22:55:29Z",  "email": "[email protected]",  "id": 35436,  "locale": "en-US",  "locale_id": 1,  "name": "Johnny End User",  "organization_id": 57542,  "phone": "+15551234567",  "photo": {    "content_type": "image/png",    "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",    "file_name": "my_funny_profile_pic.png",    "id": 928374,    "size": 166144,    "thumbnails": [      {        "content_type": "image/png",        "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",        "file_name": "my_funny_profile_pic_thumb.png",        "id": 928375,        "size": 58298      }    ]  },  "role": "end-user",  "time_zone": "Copenhagen",  "updated_at": "2011-05-05T10:38:52Z",  "url": "https://company.zendesk.com/api/v2/end_users/35436.json",  "verified": true}

Show End User

  • GET /api/v2/end_users/{user_id}

Allowed for

  • End users

Parameters

Name Type In Required Description
user_id integer Path true The ID of the user

Using curl

curl https://{subdomain}.zendesk.com/api/v2/end_users/{user_id} \-v -u {email_address}:{password}

Example Response

Status 200 OK
{  "user": {    "created_at": "2009-07-20T22:55:29Z",    "email": "[email protected]",    "id": 35436,    "locale": "en-US",    "locale_id": 1,    "name": "Johnny End User",    "organization_id": 57542,    "phone": "+15551234567",    "photo": {      "content_type": "image/png",      "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",      "file_name": "my_funny_profile_pic.png",      "id": 928374,      "size": 166144,      "thumbnails": [        {          "content_type": "image/png",          "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",          "file_name": "my_funny_profile_pic_thumb.png",          "id": 928375,          "size": 58298        }      ]    },    "role": "end-user",    "time_zone": "Copenhagen",    "updated_at": "2011-05-05T10:38:52Z",    "url": "https://company.zendesk.com/api/v2/end_users/35436.json",    "verified": true  }}

Update End User

  • PUT /api/v2/end_users/{user_id}

Allowed for

  • End users

Parameters

Name Type In Required Description
user_id integer Path true The ID of the user

Using curl

curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/api/v2/end_users/{user_id} \  -H "Content-Type: application/json" -X PUT -d '{"user": {"name": "Roger Wilco II"}}'

Example Response

Status 200 OK
{  "user": {    "created_at": "2009-07-20T22:55:29Z",    "email": "[email protected]",    "id": 9873843,    "locale": "en-US",    "locale_id": 1,    "name": "Roger Wilco II",    "organization_id": 57542,    "phone": "+15551234567",    "photo": {      "content_type": "image/png",      "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",      "file_name": "my_funny_profile_pic.png",      "id": 928374,      "size": 166144,      "thumbnails": [        {          "content_type": "image/png",          "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",          "file_name": "my_funny_profile_pic_thumb.png",          "id": 928375,          "size": 58298        }      ]    },    "role": "end-user",    "time_zone": "Copenhagen",    "updated_at": "2011-05-05T10:38:52Z",    "url": "https://company.zendesk.com/api/v2/end_users/35436.json",    "verified": true  }}