Sign in
Members

Update workspace member

patch/v1/workspaces/{workspace_id}/members/{user_id}

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Id of the workspace that owns the resource.

user_idstring uuid required

Id of the user.

Id of the user.

Headers

Idempotency-Keystring

Opaque key making this request safe to retry. The first request with a given key executes; a later request with the same key returns that first response with Idempotent-Replayed: true instead of executing again. The key covers the method, path, query, and body it was first used with; reusing it for a different request is rejected with 422. Replayable for 24 hours.

Request body

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'member'
status'active' | 'suspended'

Response

Successful Response

membership_idstring uuid required

The workspace membership's unique identifier.

user_idstring uuid required

The member's user id.

emailstring required

The member's email address.

namestring nullable

The member's display name, if set.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'member' required
status'active' | 'suspended' required

Changes

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