Chilkat Online Tools

Perl / Support API / Set Organization as Default

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

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

# resp is a HttpResponse
$resp = $http->QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/organizations/:organization_id/make_default");
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

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

    exit;
}

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

# {
#   "organization_membership": {
#     "user_id": "<integer>",
#     "organization_id": "<integer>",
#     "default": "<boolean>",
#     "created_at": "<dateTime>",
#     "id": "<integer>",
#     "organization_name": "<string>",
#     "updated_at": "<dateTime>",
#     "url": "<string>",
#     "view_tickets": "<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("organization_membership.user_id");
$Organization_id = $jResp->stringOf("organization_membership.organization_id");
$Default = $jResp->stringOf("organization_membership.default");
$Created_at = $jResp->stringOf("organization_membership.created_at");
$Id = $jResp->stringOf("organization_membership.id");
$Organization_name = $jResp->stringOf("organization_membership.organization_name");
$Updated_at = $jResp->stringOf("organization_membership.updated_at");
$v_Url = $jResp->stringOf("organization_membership.url");
$View_tickets = $jResp->stringOf("organization_membership.view_tickets");

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/organizations/:organization_id/make_default

Postman Collection Item JSON

{
  "name": "Set Organization as Default",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/organizations/:organization_id/make_default",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "organizations",
        ":organization_id",
        "make_default"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "organization_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Sets the default organization membership of a given user.\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/organizations/:organization_id/make_default",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "organizations",
            ":organization_id",
            "make_default"
          ],
          "variable": [
            {
              "key": "user_id"
            },
            {
              "key": "organization_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_membership\": {\n    \"user_id\": \"<integer>\",\n    \"organization_id\": \"<integer>\",\n    \"default\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"organization_name\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"view_tickets\": \"<boolean>\"\n  }\n}"
    }
  ]
}