autoit / Support API / Make Identity Primary
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id/make_primary")
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sUser_id
Local $sV_type
Local $sValue
Local $sCreated_at
Local $sDeliverable_state
Local $sId
Local $sPrimary
Local $sUndeliverable_count
Local $sUpdated_at
Local $sUrl
Local $sVerified
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("identities")
While $i < $iCount_i
$oJResp.I = $i
$sUser_id = $oJResp.StringOf("identities[i].user_id")
$sV_type = $oJResp.StringOf("identities[i].type")
$sValue = $oJResp.StringOf("identities[i].value")
$sCreated_at = $oJResp.StringOf("identities[i].created_at")
$sDeliverable_state = $oJResp.StringOf("identities[i].deliverable_state")
$sId = $oJResp.StringOf("identities[i].id")
$sPrimary = $oJResp.StringOf("identities[i].primary")
$sUndeliverable_count = $oJResp.StringOf("identities[i].undeliverable_count")
$sUpdated_at = $oJResp.StringOf("identities[i].updated_at")
$sUrl = $oJResp.StringOf("identities[i].url")
$sVerified = $oJResp.StringOf("identities[i].verified")
$i = $i + 1
Wend
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}"
}
]
}
