Chilkat Online Tools

autoit / Support API / Bulk Delete Memberships

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("DELETE","https://example.zendesk.com/api/v2/organization_memberships/destroy_many?ids=<integer>&ids=<integer>")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sId
Local $sIndex

Local $sId = $oJResp.StringOf("job_status.id")
Local $sMessage = $oJResp.StringOf("job_status.message")
Local $sProgress = $oJResp.StringOf("job_status.progress")
Local $sStatus = $oJResp.StringOf("job_status.status")
Local $sTotal = $oJResp.StringOf("job_status.total")
Local $sV_Url = $oJResp.StringOf("job_status.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("job_status.results")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("job_status.results[i].id")
    $sIndex = $oJResp.StringOf("job_status.results[i].index")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Bulk Delete Memberships",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_memberships/destroy_many?ids=<integer>&ids=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_memberships",
        "destroy_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<integer>",
          "description": "The IDs of the organization memberships to delete"
        },
        {
          "key": "ids",
          "value": "<integer>",
          "description": "The IDs of the organization memberships to delete"
        }
      ]
    },
    "description": "Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. The `organization_id` of the unassigned tickets is set to null.\n\n#### Response\n\nThis endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.\n\n#### Allowed For\n\n* Agents\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/organization_memberships/destroy_many?ids=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_memberships",
            "destroy_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<integer>",
              "description": "The IDs of the organization memberships to delete"
            }
          ]
        }
      },
      "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}"
    }
  ]
}