Chilkat Online Tools

Xojo / 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.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id/make_primary")
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim user_id As String
Dim v_type As String
Dim value As String
Dim created_at As String
Dim deliverable_state As String
Dim id As String
Dim primary As String
Dim undeliverable_count As String
Dim updated_at As String
Dim url As String
Dim verified As String

Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("identities")
While i < count_i
    jResp.I = i
    user_id = jResp.StringOf("identities[i].user_id")
    v_type = jResp.StringOf("identities[i].type")
    value = jResp.StringOf("identities[i].value")
    created_at = jResp.StringOf("identities[i].created_at")
    deliverable_state = jResp.StringOf("identities[i].deliverable_state")
    id = jResp.StringOf("identities[i].id")
    primary = jResp.StringOf("identities[i].primary")
    undeliverable_count = jResp.StringOf("identities[i].undeliverable_count")
    updated_at = jResp.StringOf("identities[i].updated_at")
    url = jResp.StringOf("identities[i].url")
    verified = jResp.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}"
    }
  ]
}