Directory Users

Updates directory users that match a condition.

  • Only the fields included in the request body are modified; unspecified fields are left unchanged.
  • To clear a field value, pass null for that field.
  • where is required and supports Microsoft SQL Server syntax (LIKE, AND, OR, NOT, IN, BETWEEN, etc.). Be cautious: a broad WHERE clause will update all matching records. To update a single record, filter by UserGUID.
  • If echo is true, the affected records are returned in the response (limited to the first 1000 records regardless of how many were actually updated).
  • If echo is false (default), only the count of affected records is returned.
  • Note: bulk PATCH by WHERE clause is a Caspio extension; RFC 5789 targets a single identified resource.
patch/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).

Query parameters

echoboolean

When true, returns the updated users in the response. Default: false.

Request body

wherestring required

WHERE clause (required, Microsoft SQL Server syntax). Determines which users are updated. A broad clause updates all matching users. To update a single user, filter by PK_ID or another unique field. Examples: 'PK_ID=42', 'Status=N'Open' AND AssignedTo=N'John''.

recordValuesobject required

Field name/value pairs to update. Only include fields that should change; unspecified fields remain unchanged. Only include editable fields — do not include auto-generated fields (Autonumber, Timestamp, Random ID, GUID, Formula). Example: {"Status": "Active", "Notes": "Updated by admin"}.

Response

OK

usersAffectedinteger
dataobject[] nullable

Response payload

Changes

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