AGagentmail-to
accounts

Update Account

Changed on

Updates one account. Set status to disabled to stop the inbox from signing in at the app 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 an app, so it cannot be disabled in advance. A disable applies to that inbox at that app whichever sign-in key is used: the app'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 app'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.

patch/v0/accounts/{account_id}/update

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/accounts/{account_id}/update
  • Auth
    HTTP bearer

Path parameters

account_idstring uuid required

ID of account.

Request body

status'enabled' | 'disabled'

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

Response

Response with status 200

account_idstring uuid required

ID of account.

app_idstring uuid required

ID of app.

app_namestring

Display name of app.

inbox_idstring required

The ID of the inbox.

pod_idstring required

ID of pod.

organization_idstring required

ID of organization.

first_signed_in_atstring date-time required

Time of first sign-in at app.

last_signed_in_atstring date-time required

Time of most recent sign-in at app.

sign_in_countinteger required

Number of sign-ins at app.

status'disabled'

disabled refuses every new sign-in for the account until it is re-enabled. Access tokens already issued are not revoked.

disabled_atstring date-time

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

Changes