Chilkat Online Tools

Go / Support API / Bulk Delete Memberships

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("login")
    http.SetPassword("password")

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

    resp := http.QuickRequest("DELETE","https://example.zendesk.com/api/v2/group_memberships/destroy_many?ids=<string>")
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

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

    // {
    //   "job_status": {
    //     "id": "<string>",
    //     "message": "<string>",
    //     "progress": "<integer>",
    //     "results": [
    //       {
    //         "id": "<integer>",
    //         "index": "<integer>"
    //       },
    //       {
    //         "id": "<integer>",
    //         "index": "<integer>"
    //       }
    //     ],
    //     "status": "<string>",
    //     "total": "<integer>",
    //     "url": "<string>"
    //   }
    // }

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

    var id *string = new(string)
    var index *string = new(string)

    Id := jResp.StringOf("job_status.id")
    Message := jResp.StringOf("job_status.message")
    Progress := jResp.StringOf("job_status.progress")
    Status := jResp.StringOf("job_status.status")
    Total := jResp.StringOf("job_status.total")
    v_Url_Ref.html">Url := jResp.StringOf("job_status.url")
    i := 0
    count_i := jResp.SizeOfArray("job_status.results")
    for i < count_i {
        jResp.SetI(i)
        id = jResp.StringOf("job_status.results[i].id")
        index = jResp.StringOf("job_status.results[i].index")
        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

curl  -u login:password -X DELETE
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/group_memberships/destroy_many?ids=<string>

Postman Collection Item JSON

{
  "name": "Bulk Delete Memberships",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/group_memberships/destroy_many?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "group_memberships",
        "destroy_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "Id of the group memberships to delete. Comma separated"
        }
      ]
    },
    "description": "Immediately removes users from groups and schedules a job to unassign all working tickets that are assigned to the given user and group combinations.\n\n#### Allowed For\n\n* Admins\n* Agents assigned to a custom role with permissions to manage group memberships (Enterprise only)\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/group_memberships/destroy_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "group_memberships",
            "destroy_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "Id of the group memberships to delete. Comma separated"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_status\": {\n    \"id\": \"<string>\",\n    \"message\": \"<string>\",\n    \"progress\": \"<integer>\",\n    \"results\": [\n      {\n        \"id\": \"<integer>\",\n        \"index\": \"<integer>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"index\": \"<integer>\"\n      }\n    ],\n    \"status\": \"<string>\",\n    \"total\": \"<integer>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}