Update the authenticated user

patch

https://api.instill-ai.com/v1beta/user

Updates the information of the authenticated user.

In REST requests, only the supplied user fields will be taken into account
when updating the resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The user fields that will replace the existing ones.

AuthenticatedUser contains the information of an authenticated user, i.e.,
the public user information plus some fields that should only be accessed by
the user themselves.

uid

string

User UUID. This field is optionally set by users on creation (it will be
server-generated if unspecified).

string

required

Resource ID (used in name as the last segment). This conforms to
RFC-1034, which restricts to letters, numbers, and hyphen, with the first
character a letter, the last a letter or a number, and a 63 character
maximum.

Note that the ID can be updated.

string

required

Email.

role

string

Role.

It must be one of the following allowed roles:

manager
ai-researcher
ai-engineer
data-engineer
data-scientist
analytics-engineer
hobbyist

newsletterSubscription

boolean

required

This defines whether the user is subscribed to Instill AI's newsletter.

cookieToken

string

Console cookie token.

onboardingStatus

string

enum

OnboardingStatus describes the status of the user onboarding process.

ONBOARDING_STATUS_IN_PROGRESS: In progress, i.e., the user has initiated the onboarding process
but has not yet completed it.
ONBOARDING_STATUS_COMPLETED: Completed.

Allowed:

Responses

200A successful response.

401Returned when the client credentials are not valid.

defaultAn unexpected error response.