Chilkat Online Tools

.NET Core C# / Support API / Set Membership as Default

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

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

Chilkat.HttpResponse resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/group_memberships/:group_membership_id/make_default");
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

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

// {
//   "group_memberships": [
//     {
//       "user_id": "<integer>",
//       "group_id": "<integer>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "id": "<integer>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     },
//     {
//       "user_id": "<integer>",
//       "group_id": "<integer>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "id": "<integer>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     }
//   ]
// }

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

string user_id;
string group_id;
string created_at;
string default;
string id;
string updated_at;
string url;

int i = 0;
int count_i = jResp.SizeOfArray("group_memberships");
while (i < count_i) {
    jResp.I = i;
    user_id = jResp.StringOf("group_memberships[i].user_id");
    group_id = jResp.StringOf("group_memberships[i].group_id");
    created_at = jResp.StringOf("group_memberships[i].created_at");
    default = jResp.StringOf("group_memberships[i].default");
    id = jResp.StringOf("group_memberships[i].id");
    updated_at = jResp.StringOf("group_memberships[i].updated_at");
    url = jResp.StringOf("group_memberships[i].url");
    i = i + 1;
}

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/group_memberships/:group_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/group_memberships/:group_membership_id/make_default",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "group_memberships",
        ":group_membership_id",
        "make_default"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "group_membership_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/group_memberships/:group_membership_id/make_default",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "group_memberships",
            ":group_membership_id",
            "make_default"
          ],
          "variable": [
            {
              "key": "user_id"
            },
            {
              "key": "group_membership_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"group_memberships\": [\n    {\n      \"user_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"user_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}