DataFlex / Support API / Make Identity Primary
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sUser_id
String sV_type
String sValue
String sCreated_at
String sDeliverable_state
String sId
String sPrimary
String sUndeliverable_count
String sUpdated_at
String sUrl
String sVerified
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "PUT" "https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id/make_primary" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "identities" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "identities[i].user_id" To sUser_id
Get ComStringOf Of hoJResp "identities[i].type" To sV_type
Get ComStringOf Of hoJResp "identities[i].value" To sValue
Get ComStringOf Of hoJResp "identities[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "identities[i].deliverable_state" To sDeliverable_state
Get ComStringOf Of hoJResp "identities[i].id" To sId
Get ComStringOf Of hoJResp "identities[i].primary" To sPrimary
Get ComStringOf Of hoJResp "identities[i].undeliverable_count" To sUndeliverable_count
Get ComStringOf Of hoJResp "identities[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "identities[i].url" To sUrl
Get ComStringOf Of hoJResp "identities[i].verified" To sVerified
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
