Chilkat Online Tools

lianja / Support API / Set Organization as Default

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/organizations/:organization_id/make_default")
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

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

lcUser_id = loJResp.StringOf("organization_membership.user_id")
lcOrganization_id = loJResp.StringOf("organization_membership.organization_id")
lcDefault = loJResp.StringOf("organization_membership.default")
lcCreated_at = loJResp.StringOf("organization_membership.created_at")
lcId = loJResp.StringOf("organization_membership.id")
lcOrganization_name = loJResp.StringOf("organization_membership.organization_name")
lcUpdated_at = loJResp.StringOf("organization_membership.updated_at")
lcV_Url = loJResp.StringOf("organization_membership.url")
lcView_tickets = loJResp.StringOf("organization_membership.view_tickets")


release loHttp
release loSbResponseBody
release loJResp

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}"
    }
  ]
}