younifyd
Menu

Destroy Many Users

Bulk Delete Users

DELETE/api/v2/users/destroy_many

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the Destroy Many Users action (under Users).
  3. Fill in the fields below, then reference the result from later steps as {{destroyManyUsers.response.data}}.

Request

Query parameters

idsstring

Id of the users to delete. Comma separated

external_idsstring

External Id of the users to delete. Comma separated

brand_idoneOf

Scopes the deletion of users matched by `external_ids` to a specific brand or to account-scoped (brand-less) users. Only applicable when the account has brand separation enabled (`brand_user_separation_eap`); ignored otherwise so existing numeric callers continue to behave as before. Accepted values: * `0` — restrict the lookup to account-scoped (brand-less) users only. * A numeric brand id — restrict to that brand. Brands without `user_separation` enabled collapse to account scope (`0`). Rejected with `400 Bad Request`: * `all` — cross-brand deletion is not supported on this endpoint. * Any other non-numeric string. * A numeric brand id that does not exist on the account. * Combining `brand_id` with `ids` (use `external_ids` instead — `ids` are globally unique so brand scoping is meaningless). When `external_ids` is provided without `brand_id`, the request defaults to account scope (`0`). When forwarded to the bulk-delete background job, the resolved brand id is always passed as an Integer (`0` for account scope; the brand id otherwise) for backward compatibility with existing job consumers.

Response

Returns 200 with an object. Read it in later steps with {{destroyManyUsers.response.data.<field>}}.

job_statusobject
idstring

Automatically assigned when the job is queued

job_typestring

The type of the job

messagestring

Message from the job worker, if any

progressinteger

Number of tasks that have already been completed

resultsoneOf

Result data from processed tasks. See [Results](#results) below

statusstring

The current status. One of the following: "queued", "working", "failed", "completed"

totalinteger

The total number of tasks this job is batching through

urlstring

The URL to poll for status updates

json
{
  "job_status": {
    "id": "82de0b044094f0c67893ac9fe64f1a99",
    "message": "Completed at 2018-03-08 10:07:04 +0000",
    "progress": 2,
    "results": [
      {
        "action": "update",
        "id": 244,
        "status": "Updated",
        "success": true
      },
      {
        "action": "update",
        "id": 245,
        "status": "Updated",
        "success": true
      }
    ],
    "status": "completed",
    "total": 2,
    "url": "https://example.zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99"
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.