Chilkat Online Tools

Ruby / Support API / Set Membership as Default

Back to Collection Items

require '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(true)
http.put_Login("login")
http.put_Password("password")

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

# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/organization_memberships/:organization_membership_id/make_default")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "organization_memberships": [
#     {
#       "user_id": "<integer>",
#       "organization_id": "<integer>",
#       "default": "<boolean>",
#       "created_at": "<dateTime>",
#       "id": "<integer>",
#       "organization_name": "<string>",
#       "updated_at": "<dateTime>",
#       "url": "<string>",
#       "view_tickets": "<boolean>"
#     },
#     {
#       "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

i = 0
count_i = jResp.SizeOfArray("organization_memberships")
while i < count_i
    jResp.put_I(i)
    user_id = jResp.stringOf("organization_memberships[i].user_id")
    organization_id = jResp.stringOf("organization_memberships[i].organization_id")
    default = jResp.stringOf("organization_memberships[i].default")
    created_at = jResp.stringOf("organization_memberships[i].created_at")
    id = jResp.stringOf("organization_memberships[i].id")
    organization_name = jResp.stringOf("organization_memberships[i].organization_name")
    updated_at = jResp.stringOf("organization_memberships[i].updated_at")
    url = jResp.stringOf("organization_memberships[i].url")
    view_tickets = jResp.stringOf("organization_memberships[i].view_tickets")
    i = i + 1
end

Curl Command

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

Postman Collection Item JSON

{
  "name": "Set Membership as Default",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/organization_memberships/:organization_membership_id/make_default",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "organization_memberships",
        ":organization_membership_id",
        "make_default"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "organization_membership_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Sets the default organization membership of a given user.\n\n#### Allowed for\n\n* Admins\n* Agents when setting the default organization membership for an end user\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/organization_memberships/:organization_membership_id/make_default",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "organization_memberships",
            ":organization_membership_id",
            "make_default"
          ],
          "variable": [
            {
              "key": "user_id"
            },
            {
              "key": "organization_membership_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_memberships\": [\n    {\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    {\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  ]\n}"
    }
  ]
}