DELETE /api/v2/users/destroy_many

Accepts a comma-separated list of up to 100 user ids.

The request takes an ids or an external_ids query parameter.

Allowed for

Admins

Response

This endpoint returns a job_status JSON object and queues a background job to do the work. Use the Show Job Status endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See Job limit for more information.

Servers

https://{subdomain}.{domain}.com

Query parameters

Name Type Required Description

Name	Type	Required	Description
`external_ids`	String	No	External Id of the users to delete. Comma separated
`brand_id`		No	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.
`ids`	String	No	Id of the users to delete. Comma separated

external_ids

String

External Id of the users to delete. Comma separated

brand_id

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.

ids

String

Id of the users to delete. Comma separated

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.