Directory Users

Deletes directory users that match a condition.

This operation is irreversible. where is required and supports Microsoft SQL Server syntax. A broad WHERE clause will delete all matching records. To delete a single record, filter by UserGUID or another unique field. Returns the count of deleted records.

delete/v4/directories/{directoryId}/users/bulk

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/directories/{directoryId}/users/bulk
  • Auth: API key in header Authorization

Path parameters

directoryIdstring required

The directory identifier (6-character alphanumeric code).

Request body

wherestring required

WHERE clause (required, Microsoft SQL Server syntax). Determines which users are deleted. This is irreversible. A broad clause deletes all matching users. To delete a single user, filter by PK_ID or another unique field. Examples: 'PK_ID=42', 'Status=N'Archived' AND CreatedDate<'2025-01-01''.

Response

OK

usersAffectedinteger

Changes

No recorded changes to this operation across all 1 revision of this API.