Skip to content

Brex: Update location

Brex team.teamUpdateLocation: arguments, response, policy and SDK examples.

← Team operations · Get started

Operation brex.team_updatelocation

Provider route: PUT /v2/locations/{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["team"]["teamUpdateLocation"]>[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.team.teamUpdateLocation(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.team.team_update_location(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
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeyJSONOptional
headers.Idempotency-Key (anyOf 1)stringAlternative
headers.Idempotency-Key (anyOf 2)nullAlternative
bodyModelRequired within parentExpand Update location — request body — body

Referenced models: Update location — 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 location — response body

Referenced models: Get location — response body

Get location — response body
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the location
description (anyOf 2)nullAlternative
idstringRequired within parent
namestringRequired within parentName of the location
Update location — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the location. Pass null or an empty string to clear it.
description (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeName of the location. Cannot be blank when supplied.
Minimum length: 1
name (anyOf 2)nullAlternative

SDK function policy ID: brex.team_updatelocation. Catalog operation: team:updateLocation. 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: ["locations"]

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.