Chilkat Online Tools

lianja / Support API / Bulk Delete Users

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("DELETE","https://example.zendesk.com/api/v2/users/destroy_many?ids=<string>&external_ids=<string>")
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)

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

lcId = loJResp.StringOf("job_status.id")
lcMessage = loJResp.StringOf("job_status.message")
lcProgress = loJResp.StringOf("job_status.progress")
lcStatus = loJResp.StringOf("job_status.status")
lcTotal = loJResp.StringOf("job_status.total")
lcV_Url = loJResp.StringOf("job_status.url")
i = 0
lnCount_i = loJResp.SizeOfArray("job_status.results")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("job_status.results[i].id")
    lcIndex = loJResp.StringOf("job_status.results[i].index")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Bulk Delete Users",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/destroy_many?ids=<string>&external_ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        "destroy_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "Id of the users to delete. Comma separated"
        },
        {
          "key": "external_ids",
          "value": "<string>",
          "description": "External Id of the users to delete. Comma separated"
        }
      ]
    },
    "description": "Accepts a comma-separated list of up to 100 user ids.\n\nThe request takes an `ids` or an `external_ids` query parameter.\n\n#### Allowed for\n\n- Admins\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.\nUse the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.\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/users/destroy_many?ids=<string>&external_ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            "destroy_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "Id of the users to delete. Comma separated"
            },
            {
              "key": "external_ids",
              "value": "<string>",
              "description": "External Id of the users 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}"
    }
  ]
}