Skip to navigation
API ReferenceAccounts

Update Account

Updates one account. Set status to disabled to stop the inbox from signing in at the provider again, or to enabled to re-enable it. Idempotent: disabling an already disabled account keeps its original disabled_at, and enabling an enabled account is a no-op.

Find the account_id with List Accounts. An account exists only after an inbox’s first sign-in at a provider, so it cannot be disabled in advance. A disable applies to that inbox at that provider whichever sign-in key is used: the provider’s next authorization ends in access_denied, and a code issued earlier is refused with invalid_grant. Access tokens already issued stay valid until they expire, and the provider’s own session is unaffected.

Requires account_update, which sign-in keys (type: public_key) cannot hold, so call this with a bearer API key. An account outside the key’s scope is a 404. A 409 means the account changed during the write; read it again and retry.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idUUIDRequired
ID of account.

Request

This endpoint expects an object.
statusenumOptional

Status to set. disabled stops the inbox from signing in at the provider; enabled re-enables it. An enabled account reads back with no status.

Response

This endpoint returns an object.
account_idUUID
ID of account.
provider_idUUID
ID of provider.
inbox_idstring
The ID of the inbox.
pod_idstring
ID of pod.
organization_idstring
ID of organization.
first_signed_in_atdatetime

Time of first sign-in at provider.

last_signed_in_atdatetime

Time of most recent sign-in at provider.

sign_in_countinteger

Number of sign-ins at provider.

provider_namestringOptional
Display name of provider.
statusenumOptional
Present only while the account is disabled. Absent means the inbox may sign in.
disabled_atdatetimeOptional

Time at which the account was disabled. Present only while status is disabled.

Errors

400
Validation Error
404
Not Found Error
409
Conflict Error