TCL / Support API / Make Identity Primary
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PUT" "https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id/make_primary"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "identities": [
# {
# "user_id": "<integer>",
# "type": "phone_number",
# "value": "<string>",
# "created_at": "<dateTime>",
# "deliverable_state": "<string>",
# "id": "<integer>",
# "primary": "<boolean>",
# "undeliverable_count": "<integer>",
# "updated_at": "<dateTime>",
# "url": "<string>",
# "verified": "<boolean>"
# },
# {
# "user_id": "<integer>",
# "type": "google",
# "value": "<string>",
# "created_at": "<dateTime>",
# "deliverable_state": "<string>",
# "id": "<integer>",
# "primary": "<boolean>",
# "undeliverable_count": "<integer>",
# "updated_at": "<dateTime>",
# "url": "<string>",
# "verified": "<boolean>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "identities"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set user_id [CkJsonObject_stringOf $jResp "identities[i].user_id"]
set v_type [CkJsonObject_stringOf $jResp "identities[i].type"]
set value [CkJsonObject_stringOf $jResp "identities[i].value"]
set created_at [CkJsonObject_stringOf $jResp "identities[i].created_at"]
set deliverable_state [CkJsonObject_stringOf $jResp "identities[i].deliverable_state"]
set id [CkJsonObject_stringOf $jResp "identities[i].id"]
set primary [CkJsonObject_stringOf $jResp "identities[i].primary"]
set undeliverable_count [CkJsonObject_stringOf $jResp "identities[i].undeliverable_count"]
set updated_at [CkJsonObject_stringOf $jResp "identities[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "identities[i].url"]
set verified [CkJsonObject_stringOf $jResp "identities[i].verified"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id/make_primary
Postman Collection Item JSON
{
"name": "Make Identity Primary",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/make_primary",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"identities",
":user_identity_id",
"make_primary"
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
},
{
"key": "user_identity_id",
"value": "<integer>"
}
]
},
"description": "Sets the specified identity as primary. To change other attributes, use the [Update Identity](#update-identity) endpoint. This is a collection-level operation and the correct behavior for an API client is to subsequently reload the entire collection.\n\nThe 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.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/make_primary",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"identities",
":user_identity_id",
"make_primary"
],
"variable": [
{
"key": "user_id"
},
{
"key": "user_identity_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"identities\": [\n {\n \"user_id\": \"<integer>\",\n \"type\": \"phone_number\",\n \"value\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"deliverable_state\": \"<string>\",\n \"id\": \"<integer>\",\n \"primary\": \"<boolean>\",\n \"undeliverable_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n {\n \"user_id\": \"<integer>\",\n \"type\": \"google\",\n \"value\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"deliverable_state\": \"<string>\",\n \"id\": \"<integer>\",\n \"primary\": \"<boolean>\",\n \"undeliverable_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
