Field Values

Delete custom field values

Delete custom field values (up to 1000 values at once) for a specific field

delete/v1/fields/{field_id}/values

Request

Base URL
https://api.brex.com
Auth
OAuth 2
Authorization codehttps://accounts-api.brex.com/oauth2/default/v1/authorize
Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
Scopesfields.write
TypeScript
https://skmtc.dev/brex-com/apis/fields-api/docs/v1/fields/:field_id/values/delete.ts
A function with typed inputs. Its response is checked against the schema.

field_idstring required

The Field Brex identifier

{
  "items": [
    {
      "brex_id": "efo_foobar"
    }
  ]
}

Delete custom field value list response

DeletedFieldValueListResponse required

Represents the confirmation of number of deleted field values

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