Chilkat Online Tools

phpAx / Support API / Update Target

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';

$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('PUT','https://example.zendesk.com/api/v2/targets/:target_id');
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "target": {
//     "project_id": "<string>",
//     "resource": "<string>",
//     "target_url": "<string>",
//     "title": "<string>",
//     "token": "<string>",
//     "type": "<string>",
//     "active": "<boolean>",
//     "created_at": "<dateTime>",
//     "id": "<integer>",
//     "message_id": "<string>",
//     "password": "<string>",
//     "todo_list_id": "<string>",
//     "username": "<string>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$Project_id = $jResp->stringOf('target.project_id');
$Resource = $jResp->stringOf('target.resource');
$Target_url = $jResp->stringOf('target.target_url');
$Title = $jResp->stringOf('target.title');
$Token = $jResp->stringOf('target.token');
$v_Type = $jResp->stringOf('target.type');
$Active = $jResp->stringOf('target.active');
$Created_at = $jResp->stringOf('target.created_at');
$Id = $jResp->stringOf('target.id');
$Message_id = $jResp->stringOf('target.message_id');
$Password = $jResp->stringOf('target.password');
$Todo_list_id = $jResp->stringOf('target.todo_list_id');
$Username = $jResp->stringOf('target.username');

?>

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/targets/:target_id

Postman Collection Item JSON

{
  "name": "Update Target",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/targets/:target_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "targets",
        ":target_id"
      ],
      "variable": [
        {
          "key": "target_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n* Admins\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/targets/:target_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "targets",
            ":target_id"
          ],
          "variable": [
            {
              "key": "target_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"target\": {\n    \"project_id\": \"<string>\",\n    \"resource\": \"<string>\",\n    \"target_url\": \"<string>\",\n    \"title\": \"<string>\",\n    \"token\": \"<string>\",\n    \"type\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"message_id\": \"<string>\",\n    \"password\": \"<string>\",\n    \"todo_list_id\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}"
    }
  ]
}