Users

Delete User

Deletes a user based on the user ID supplied. Note that users are hard-deleted, and this is not reversible. If a user is a system user, it cannot be deleted.

Authorization Required:

Designer Administrator

delete/users/{userId}

Request

Base URL
https://env.unqork.io/api/1.0
Auth
OAuth 2
Client credentials
Password
Token URLhttps://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
TypeScript
https://skmtc.dev/unqork/apis/unqork-customer-api/docs/users/:userId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

ID of user to delete

Response

User deleted

Changes

No recorded changes to this operation across all 6 revisions of this API.