Social Media Means
Photo by Monstera Pexels Logo Photo: Monstera

What are user identities?

A user identity is something that can be used to identify an individual. Most likely, it's an email address, a Twitter handle, or a phone number.

How do I become a social worker without going to university?
How do I become a social worker without going to university?

Can I get into social work without a degree? You cannot become a social worker without an approved qualification – a BA degree or postgraduate...

Read More »
What are advantages of online learning?
What are advantages of online learning?

It helps you develop and stick to healthy habits So if you're learning from home, you can take a midday jog or online Pilates class. You can even...

Read More »

A user identity is something that can be used to identify an individual. Most likely, it's an email address, a Twitter handle, or a phone number. Zendesk Support supports a series of different such identities.

JSON format

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

Name Type Read-only Mandatory Description created_at string true false The time the identity was created deliverable_state string true false Email identity type only. Indicates if Zendesk sends notifications to the email address. See Deliverable state id integer true false Automatically assigned on creation primary boolean false false If the identity is the primary identity. *Writable only when creating, not when updating. Use the Make Identity Primary endpoint instead type string true true The type of this identity. Allowed values are "email", "twitter", "facebook", "google", "phone_number", "agent_forwarding", "any_channel", "foreign", or "sdk". undeliverable_count integer true false The number of times a soft-bounce response was received at that address updated_at string true false The time the identity was updated url string true false The API url of this identity user_id integer true true The id of the user value string true true The identifier for this identity, such as an email address verified boolean false false If the identity has been verified If the identity is of type "phone_number", the phone number must be a direct line, not a shared phone number. See Phone Number in the Users API.

Deliverable state

When a user has multiple email addresses, Zendesk will choose the best one to deliver email notifications. The deliverable_state property helps to determine that identity. If the value is "deliverable", Zendesk will likely use that identity over other email addresses; in the same way, Zendesk will not choose an email address that will likely fail to receive an email. Value Description deliverable Email address marked as deliverable undeliverable Email address marked as undeliverable ticket_sharing_partner Email address used by a Ticket Sharing Partner integration between two Zendesk instances. Considered undeliverable to prevent email loops mailing_list Email address used for mailing lists with multiple individual recipients. Considered undeliverable to prevent email loops reserved_example Email address used for documentation and testing only. Includes @example.com, @example.net, @example.org, and @example.edu. Considered undeliverable because it's a reserved example domain machine Email address used by other providers to deliver machine-generated emails (like automatic responses, marketing campaigns). Considered undeliverable to prevent email loops mailer_daemon Email address reserved for delivery notifications agents. Includes [email protected] and @mailer-daemon.domain.com. Considered undeliverable because it's a machine address mandatory Email address marked as mandatory. Zendesk will prefer this address in some situations when the user switches identities

Example

{ "created_at" : "2011-07-20T22:55:29Z" , "deliverable_state" : "deliverable" , "id" : 35436 , "primary" : true , "type" : "email" , "updated_at" : "2011-07-20T22:55:29Z" , "url" : "https://company.zendesk.com/api/v2/users/135/identities/35436.json" , "user_id" : 135 , "value" : [email protected]" , "verified" : true }

List Identities

GET /api/v2/users/{user_id}/identities

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

Returns a list of identities for the given user.

Use the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities.

How much money does 100k subscribers make?
How much money does 100k subscribers make?

You don't need 1 million subscribers to be successful on YouTube. Creators with 100,000 subscribers can still make decent money. Using the same...

Read More »
What do 500 subscribers get you?
What do 500 subscribers get you?

For the Community Tab to be available, you need to have 500 subscribers or enable access to advanced features on your channel. You can choose among...

Read More »

Pagination

Cursor pagination (recommended)

Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

Agents

Verified end users

Parameters

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

Using curl

Agents only

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

Using curl

Verified end users only

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

Example response(s)

200 OK Status 200 OK { "identities": [ { "created_at": "2011-07-20T22:55:29Z", "id": 35436, "primary": true, "type": "email", "updated_at": "2011-07-20T22:55:29Z", "user_id": 135, "value": " [email protected] ", "verified": true }, { "created_at": "2012-02-12T14:25:21Z", "id": 77136, "primary": false, "type": "twitter", "updated_at": "2012-02-12T14:25:21Z", "user_id": 135, "value": "didgeridooboy", "verified": true }, { "created_at": "2012-02-12T14:25:21Z", "id": 88136, "primary": true, "type": "phone_number", "updated_at": "2012-02-12T14:25:21Z", "user_id": 135, "value": "+1 555-123-4567", "verified": true } ] }

Show Identity

GET /api/v2/users/{user_id}/identities/{user_identity_id}

GET /api/v2/end_users/{user_id}/identities/{user_identity_id}

Shows the identity with the given id for a given user.

Use the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only view email or phone number identity.

Allowed For

Agents

Verified end users

Parameters

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

Using curl

Agents only

curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/identities/{user_identity_id}.json \ -v -u {email_address}:{password}

Using curl

Verified end users only

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

Example response(s)

200 OK Status 200 OK { "identity": { "created_at": "2012-02-12T14:25:21Z", "id": 77938, "primary": false, "type": "twitter", "updated_at": "2012-02-12T14:25:21Z", "user_id": 13531, "value": "cabanaboy", "verified": false } }

Create Identity

POST /api/v2/users/{user_id}/identities

POST /api/v2/end_users/{user_id}/identities.json

Adds an identity to a user's profile. An agent can add an identity to any user profile.

Supported identity types:

To create an identity without sending out a verification email, include a "verified": true property.

Allowed For

Agents

Parameters

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

Using curl

Agents only

Example response(s)

201 Created Status 201 Created { "identity": { "created_at": "2012-02-12T14:25:21Z", "id": 77938, "primary": false, "type": "twitter", "updated_at": "2012-02-12T14:25:21Z", "user_id": 13531, "value": "cabanaboy", "verified": false } }

PUT /api/v2/users/{user_id}/identities/{user_identity_id}

This endpoint allows you to:

Set the specified identity as verified (but you cannot unverify a verified identity)

Update the value property of the specified identity

You can't change an identity's primary attribute with this endpoint. You must use the Make Identity Primary endpoint instead.

Allowed For

Agents

Parameters

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

Using curl

To update verified

curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/identities/{user_identity_id}.json \ -H "Content-Type: application/json" -X PUT \ -d '{"identity": {"verified": true}}' -v -u {email_address}:{password}

Using curl

To update value

Example response(s)

What is Google space app?
What is Google space app?

If you're looking for a free, convenient spot to chat with your team, family, or coworkers, check out Google Spaces. You can access Google Spaces...

Read More »
At what amount of followers do you get paid?
At what amount of followers do you get paid?

Once influencers reach over 100k followers, they tend to start charging at least $1,000 for just one post such as Sam Ushiro who has 283k followers...

Read More »

200 OK Status 200 OK { "identity": { "created_at": "2011-07-20T22:55:29Z", "deliverable_state": "deliverable", "id": 35436, "primary": true, "type": "email", "updated_at": "2011-07-20T22:55:29Z", "user_id": 135, "value": " [email protected] ", "verified": true } }

Make Identity Primary

PUT /api/v2/users/{user_id}/identities/{user_identity_id}/make_primary

PUT /api/v2/end_users/{user_id}/identities/{user_identity_id}/make_primary

Sets the specified identity as primary. To change other attributes, use the Update Identity endpoint. This is a collection-level operation and the correct behavior for an API client is to subsequently reload the entire collection. The first endpoint is the preferred option if authenticating as an agent. If authenticating as an end user, you can only use the second endpoint. In addition, an end user can only make an email identity primary if the email is verified.

Allowed For

Agents

Verified end users

Parameters

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

Using curl

Agents only

curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/identities/{user_identity_id}/make_primary.json \ -X PUT -v -u {email_address}:{password} -d '{}' -H "Content-Type: application/json"

Using curl

Verified end users only

curl https://{subdomain}.zendesk.com/api/v2/end_users/{user_id}/identities/{user_identity_id}/make_primary.json \ -X PUT -v -u {email_address}:{password} -d '{}' -H "Content-Type: application/json" curl https://{subdomain}.zendesk.com/api/v2/end_users/{user_id}/identities/{user_identity_id}/make_primary.json \ -X PUT -v -u {email_address}/token:{api_token} -d '{}' -H "Content-Type: application/json"

Example response(s)

200 OK Status 200 OK { "identities": [ { "created_at": "2011-07-20T22:55:29Z", "id": 35436, "primary": true, "type": "email", "updated_at": "2011-07-20T22:55:29Z", "user_id": 135, "value": " [email protected] ", "verified": true }, { "created_at": "2012-02-12T14:25:21Z", "id": 77136, "primary": false, "type": "twitter", "updated_at": "2012-02-12T14:25:21Z", "user_id": 135, "value": "didgeridooboy", "verified": true }, { "created_at": "2012-02-12T14:25:21Z", "id": 88136, "primary": true, "type": "phone_number", "updated_at": "2012-02-12T14:25:21Z", "user_id": 135, "value": "+1 555-123-4567", "verified": true } ] }

Verify Identity

PUT /api/v2/users/{user_id}/identities/{user_identity_id}/verify

Sets the specified identity as verified.

Allowed For

Agents

Parameters

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

Using curl

curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/identities/{user_identity_id}/verify.json \ -X PUT -v -u {email_address}:{password} -d '{}' -H "Content-Type: application/json"

Example response(s)

200 OK Status 200 OK { "identity": { "created_at": "2012-02-12T14:25:21Z", "id": 77938, "primary": false, "type": "twitter", "updated_at": "2012-02-12T14:25:21Z", "user_id": 13531, "value": "cabanaboy", "verified": false } }

Request User Verification

PUT /api/v2/users/{user_id}/identities/{user_identity_id}/request_verification

PUT /api/v2/end_users/{user_id}/identities/{user_identity_id}/request_verification

Sends the user a verification email with a link to verify ownership of the email address.

Allowed For

Agents

Parameters

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

Using curl

Agents only

curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/identities/{user_identity_id}/request_verification.json \ -X PUT -v -u {email_address}:{password} -d '{}' -H "Content-Type: application/json"

Example response(s)

200 OK Status 200 OK

Delete Identity

DELETE /api/v2/users/{user_id}/identities/{user_identity_id}

DELETE /api/v2/end_users/{user_id}/identities/{user_identity_id}

Deletes the identity for a given user.

Allowed For

Agents

Parameters

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

Using curl

Agents only

curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/identities/{user_identity_id}.json \ -X DELETE -v -u {email_address}:{password}

Example response(s)

How much money per 1,000 views on TikTok?
How much money per 1,000 views on TikTok?

TikTok pays you for views using their Creator Fund(if you qualify). While the company doesn't fully disclose how much they pay creators, many have...

Read More »
How can I make 200 dollars overnight?
How can I make 200 dollars overnight?

How to make $200 fast, as in TODAY! 1 – Rent out your parking spot with Spot Hero. ... 2 – Rent out your clothes on StyleLend. ... 3 – Use Earnin...

Read More »
What certificate makes the most money?
What certificate makes the most money?

Given below are the top certifications that pay well. Full Stack Web Development. Cloud Computing. DevOps. Digital Marketing. Business Analytics....

Read More »
Is making 10k a month good?
Is making 10k a month good?

Is making $10,000 a month good? Yes, most people would consider $10,000 a month to be a good income. If you earn $10,000 a month, your gross income...

Read More »