Brex: Delete custom field values
Brex fields.fieldsDeleteFieldValues: arguments, response, policy and SDK examples.
← Fields operations · Get started
Operation brex.fields_deletefieldvalues
Provider route: DELETE /v1/fields/{field_id}/values. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["fieldsDeleteFieldValues"]>[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.fieldsDeleteFieldValues(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_delete_field_values(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.field_id | string | Required within parent | |
body | Model | Required within parent | Expand Delete custom field values — request body — body |
Referenced models: Delete custom field values — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Delete custom field values — response body |
Referenced models: Delete custom field values — response body
Schemas
Section titled “Schemas”Delete custom field values — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the confirmation of number of deleted field values |
Delete custom field values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete field values. It can't contain more than 1000 values at once. |
items | array | Required within parent | Maximum items: 1000 Minimum items: 1 |
items[] | Model | Each item | Expand Delete custom field values — request body — body items item |
Referenced models: Delete custom field values — request body — body items item
Delete custom field values — request body — body items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value. |
$ (oneOf 1) | Model | Alternative | Expand Delete custom field values — request body — body items item by `brex id` |
$ (oneOf 2) | Model | Alternative | Expand Delete custom field values — request body — body items item by `value id` |
$ (oneOf 3) | Model | Alternative | Expand Delete custom field values — request body — body items item by `remote id` |
Referenced models: Delete custom field values — request body — body items item by `brex id`, Delete custom field values — request body — body items item by `remote id`, Delete custom field values — request body — body items item by `value id`
Delete custom field values — request body — body items item by `brex id`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value using its `brex_id`. |
brex_id | string | Required within parent | The internal Brex ID of the field value |
Delete custom field values — request body — body items item by `remote id`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value using its `remote_id`. |
remote_id | string | Required within parent | Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) |
Delete custom field values — request body — body items item by `value id`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value using its `value_id`. |
value_id | string | Required within parent | The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.fields_deletefieldvalues. Catalog operation: fields:deleteFieldValues. 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"]