Actions66
- User Actions
- Client Actions
- Item Actions
- Item Type Actions
- Task Actions
- Service Actions
- Product Actions
- Order (OS) Actions
- Modality Actions
- Ticket Actions
- Property Actions
User → Deactivate
AI-generatedSummary
Deactivate a user record in Confirm8 by specifying its Record ID and required authentication headers. Send a request to the Confirm8 API to set the user as inactive.
Inputs
- Base URL (required) — The base URL of the Confirm8 API, e.g., https://api.confirm8.com.
- Bearer Token (required) — The Bearer token used for authorization in the API request.
- X-API-DOMAIN (required) — The X-API-DOMAIN header value required by the Confirm8 API.
- X-APIKEY-TOKEN (required) — The X-APIKEY-TOKEN header value used for API authentication.
- Record ID (required) — The unique identifier of the user record to deactivate.
- Data — JSON data, not used for deactivate operation but present for create/update.
- Filters — JSON filters, not used for deactivate operation but present for filtering in some operations.
Output shape
a single JSON object containing a success flag, the normalized resource and operation names, the API endpoint used, full URL called, relations queried, any filters applied, the HTTP method, and the data returned by the API after deactivation.
The response includes details about the API call and the updated user data. The operation requires the Record ID and will throw an error if missing. The operation uses an HTTP PUT or PATCH request to '/v3/users/{recordId}/inactive' endpoint with required authentication headers.
Examples
Example 1: Deactivate a user with Record ID '1234'
Provide Base URL 'https://api.confirm8.com', Bearer Token, X-API-DOMAIN, X-APIKEY-TOKEN, set resource to 'User', operation to 'Deactivate', and Record ID '1234'.