API Reference

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The user fields that will replace the existing ones.

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.

string

Role.

It must be one of the following allowed roles:

  • manager
  • ai-researcher
  • ai-engineer
  • data-engineer
  • data-scientist
  • analytics-engineer
  • hobbyist
boolean
required

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

string

Console cookie token.

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

Updated 10 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago