Update a custom field

patch

https://gateway.stage.bill.com/connect/v3/spend/custom-fields/{customFieldId}

Update details about an existing custom field.

Path Params

customFieldId

string

required

length ≥ 1

BILL-generated ID or UUID of the custom field

Body Params

name

string | null

Custom field name

description

string | null

Custom field description

allowCustomValues

boolean | null

Set as true if the custom field can have custom values

minimumAmountForRequirement

number | null

Minimum transaction amount where the custom field is required

required

boolean | null

Set as true if the custom field is required for all budgets. The default value is false.

global

boolean | null

Set as true if the custom field applies to all budgets. The default value is false.

selectedBudgetIds

array of strings

List of budgets where the custom field is available. Set the budget ID or UUID values.

selectedBudgetIds

requiredBudgetIds

array of strings

List of budgets where the custom field is required. Set the budget ID or UUID values.

requiredBudgetIds

Headers

apiToken

string | null

Access token for Spend & Expense API authentication

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update a custom field response