Skip to main content
PUT
Update account

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

Account ID

Body

application/json
name
string
required

Account name (lowercase, unique).

managerEmail
string<email>
required

Email of the primary account manager (required).

status
enum<string>
default:active
Available options:
active,
inactive,
deleted
credits
integer

Initial credits

aws_default_region
string

AWS region for the account's Amazon Bedrock / S3 / Transcribe calls (e.g. us-east-1). Used by every Digital Twin of the account that has no AWS keys of its own; a twin's own region wins.

aws_access_key_id
string

IAM access key id. Signs the Bedrock, transcription, image and video calls of every Digital Twin of the account that has no AWS keys of its own; a twin's own pair always wins. Applied only together with the secret.

aws_secret_access_key
string | null
write-only

IAM secret access key paired with the access key id. Write-only: never returned by the API. On update, a blank value (or the masked placeholder) keeps the stored secret and null clears it. Clearing the access key id alone also disables the account pair.

canvasClientSecret
string | null
write-only

Canvas developer key client secret. Write-only: never returned by the API (reads carry hasCanvasClientSecret). On update, a blank value (or the masked placeholder) keeps the stored secret and null clears it.

canvasFacultyAccessToken
string | null
write-only

Canvas faculty access token. Write-only: never returned by the API (reads carry hasCanvasFacultyAccessToken). On update, a blank value (or the masked placeholder) keeps the stored secret and null clears it.

Response

Account updated successfully

success
boolean
Example:

true

message
string

Success message

Example:

"User institution deleted successfully"