Chilkat Online Tools

delphiAx / Support API / Update Identity

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
User_id: WideString;
v_Type: WideString;
Value: WideString;
Created_at: WideString;
Deliverable_state: WideString;
Id: WideString;
Primary: WideString;
Undeliverable_count: WideString;
Updated_at: WideString;
v_Url: WideString;
Verified: WideString;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

http.SetRequestHeader('Accept','application/json');

resp := http.QuickRequest('PUT','https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id');
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "identity": {
//     "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

User_id := jResp.StringOf('identity.user_id');
v_Type := jResp.StringOf('identity.type');
Value := jResp.StringOf('identity.value');
Created_at := jResp.StringOf('identity.created_at');
Deliverable_state := jResp.StringOf('identity.deliverable_state');
Id := jResp.StringOf('identity.id');
Primary := jResp.StringOf('identity.primary');
Undeliverable_count := jResp.StringOf('identity.undeliverable_count');
Updated_at := jResp.StringOf('identity.updated_at');
v_Url := jResp.StringOf('identity.url');
Verified := jResp.StringOf('identity.verified');

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

Postman Collection Item JSON

{
  "name": "Update Identity",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "identities",
        ":user_identity_id"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "user_identity_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "This endpoint allows you to:\n\n* Set the specified identity as verified (but you cannot unverify a verified identity)\n* Update the `value` property of the specified identity\n\nYou can't change an identity's `primary` attribute with this endpoint. You must use the [Make Identity Primary](#make-identity-primary) endpoint instead.\n\n#### Allowed For\n\n* Agents\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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "identities",
            ":user_identity_id"
          ],
          "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  \"identity\": {\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}"
    }
  ]
}