Account

Request a mail-agent settings change (human approval required)

Credentials cannot change the workspace's email approval authority. A valid request containing emailKeywordApprovalEnabled returns 403 forbidden, even with settings:write, and even if the requested value already holds. No setting or audit row is written. Ask the workspace owner to enable or disable keyword replies in the InkSeal dashboard.

The endpoint remains available for existing clients. The settings:write scope is still checked first; a credential without it receives insufficient_scope. A missing or invalid boolean receives 400 validation_error. Agent guardrails (agentSendApproval, recipientDenyList, apiAccessPaused) are also human-only.

Use GET /account/settings with account:read to read the owner-of-record's effective flag. When enabled by that person, a DKIM-valid reply from an authorized sender may approve the reviewed draft.

patch/account/settings

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/account/settings
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes this mutation retry-safe. 1 to 255 printable ASCII characters (0x20 to 0x7e), trimmed before use. The key is scoped to the workspace and the credential that sent it. Reusing it with a different method, path, or payload answers 422 idempotency_key_reuse. A completed attempt replays its stored status and body with an Idempotent-Replay: true response header; 5xx, 429, and non-JSON answers leave the key retryable. A concurrent request holding the 90 second lease answers 409 idempotency_in_progress. Records are retained 24 hours.

Request body

emailKeywordApprovalEnabledboolean required

Human-only email approval preference. Credential writes to this field return 403 forbidden; ask the workspace owner to change it in the dashboard.

Example request

{
  "emailKeywordApprovalEnabled": true
}

Response

Legacy success shape retained for client compatibility. Credential requests cannot change this preference and valid writes now return 403 forbidden.

Example response

{
  "data": {
    "emailKeywordApprovalEnabled": true,
    "changed": true,
    "agentSendApproval": "none",
    "recipientDenyList": []
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.