Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Custom Field Budgets

Link a budget to a custom field

Assigns a custom field to a budget. The budget must belong to the same business. Only permitted when the custom field's budget_setting is SOME.

post/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets

Path parameters

client_idinteger required
Example:123

The ID of the business.

custom_field_idstring uuid required
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

The ID of the custom field.

Request body

budgetstring uuid required

The ID of the budget to link to this custom field.

Example request

{
  "budget": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

Created

idstring uuid

The unique identifier of the linked budget.

namestring

The name of the linked budget.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Marketing Q1"
}