Skip to main content
PATCH
Update a user's activation state

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

userId
string
required

The unique ID of the user to update.

Body

application/json

Sets the user's activation state.

active
boolean
required

When false, the user is deactivated; when true, the user is reactivated.

Response

User updated successfully.

A user. List responses populate the lean fields by default and add notary fields and image URLs when requested via the fields mask; the detail views (GET/PUT /v1/users/{userId}) always populate notary fields and image URLs.

id
string<uuid>
required

The user's unique ID.

name
string

The user's display name.

email
string

The user's email address.

title
string

The user's job title.

phoneNumber
string

The user's phone number.

country
string
jurisdiction
string
county
string
commissionNumber
string
notaryExpirationDate
string<date-time>
notaryExpires
boolean
deactivatedAt
string<date-time>

When the user was deactivated. Absent or null means the user is active.

getImageUrls
object[]

Download URLs for the user's signature and notary seal images (detail views only).

isNotary
boolean

Whether the user is a notary.

uploadImageUrls
object[]
deprecated

Upload (PUT) URLs returned when an image upload was requested (detail views only). Deprecated — request upload URLs via POST /v1/users/{userId}/images and upload before saving the profile.