Skip to content

Brex: Update a custom field

Brex fields.fieldsUpdateField: arguments, response, policy and SDK examples.

← Fields operations · Get started

Operation brex.fields_updatefield

Provider route: PUT /v1/fields/{id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["fields"]["fieldsUpdateField"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.fields.fieldsUpdateField(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_brex import BrexIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.fields.fields_update_field(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent
bodyModelRequired within parentExpand Update a custom field — request body — body

Referenced models: Update a custom field — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get custom field — response body

Referenced models: Get custom field — response body

Get custom field — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a field definition
brex_idstringRequired within parentThe internal Brex ID of the field
groupJSONOptional
group (anyOf 1)JSONAlternative
group (anyOf 1) (allOf 1)ModelAll variants applyExpand Get custom field — response body — group string string
group (anyOf 1) (allOf 2)JSONAll variants applyThe category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields.
group (anyOf 2)nullAlternative
is_disabledbooleanRequired within parentIndicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeThe name of the field
name (anyOf 2)nullAlternative
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the field
Format: date-time

Referenced models: Get custom field — response body — group string string

Update a custom field — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update a field
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeIndicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected.
is_disabled (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the field
name (anyOf 2)nullAlternative
Get custom field — response body — group string string
FieldTypePresenceDescription and constraints
$stringRootThe category of the field, indicating its purpose or context. Supported groups are:

* `ACCOUNTING` — Fields used to categorize transactions for accounting purposes (for example, expense categories or cost centers) that are managed directly within Brex.

* `USER` — Fields associated with users, used to capture user-specific attributes.

* `ERP` — Fields that are synced with an external ERP/accounting system through an Accounting Integration. Creating an Accounting Integration is a prerequisite for creating fields in the `ERP` group, and each `ERP` field must reference that integration through `integration_id`.

* `TRAVEL` — Fields used in the context of travel bookings and expenses.
Known values: ACCOUNTING, USER, ERP, TRAVEL

SDK function policy ID: brex.fields_updatefield. Catalog operation: fields:updateField. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["fields.write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.