Clarify API
Users

Remove a user

Removes a user from the workspace: they lose access, their campaigns stop, and their connected mailboxes disconnect. Their records stay in the workspace. The last user and the last admin cannot be removed.

DELETE
/workspaces/{workspace}/users/{userId}

Authorization

bearer
AuthorizationBearer <token>

User access token authentication for endpoints that act across workspaces. Send a WorkOS access token in the Authorization header as: Bearer <token>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

userId*string

The unique ID of the user.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Response Body

curl -X DELETE "https://example.com/workspaces/string/users/string"
Empty

List users

Returns the workspace’s users as a paginated JSON:API list. Each user includes their roles.

Change a user’s role

Sets a workspace user’s role to `admin` or `member` and returns the updated user as a JSON:API resource. Requires an admin signed in with a user access token; the last admin cannot be demoted.