Skip to content

Brex: Create custom field values

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

← Fields operations · Get started

Operation brex.fields_createfieldvalues

Provider route: POST /v1/fields/{field_id}/values. 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"]["fieldsCreateFieldValues"]>[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.fieldsCreateFieldValues(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_create_field_values(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.field_idstringRequired within parent
headersobjectRequired within parentAdditional keys: not allowed
headers.Idempotency-KeystringRequired within parent
bodyModelRequired within parentExpand Create custom field values — request body — body

Referenced models: Create custom field values — 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 Create custom field values — response body

Referenced models: Create custom field values — response body

Create custom field values — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a list of field values definition
itemsarrayRequired within parentThe list of created field values
items[]ModelEach itemExpand Get a field value — response body

Referenced models: Get a field value — response body

Create custom field values — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to create multiple field values. It can't contain more than 1000 values at once.
itemsarrayRequired within parentThe list of field values to be created
Minimum items: 1
items[]ModelEach itemExpand Create custom field values — request body — body items item

Referenced models: Create custom field values — request body — body items item

Get a field value — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a field value definition
brex_idstringRequired within parentThe internal Brex ID of the field value
field_idstringRequired within parentThe ID of the parent field this value belongs to
is_disabledbooleanRequired within parentIndicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected.
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field value from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the field value
Format: date-time
valuestringRequired within parentThe display name of the field value
value_idJSONOptional
value_id (anyOf 1)stringAlternativeThe value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
value_id (anyOf 2)nullAlternative
Create custom field values — request body — body items item
FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to create a field value
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeIndicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected.
is_disabled (anyOf 2)nullAlternative
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field value from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative
valuestringRequired within parentThe display name of the field value
value_idJSONOptional
value_id (anyOf 1)stringAlternativeThe value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
value_id (anyOf 2)nullAlternative

SDK function policy ID: brex.fields_createfieldvalues. Catalog operation: fields:createFieldValues. 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: ["field_values.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.