Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Budget Owners

Add budget owner

Adds a user (or pending invite) as an owner of the budget. Provide exactly one of user or invite. If an invite has already been accepted, the response will contain user rather than invite.

If the same user or invite was previously removed from this budget, the original record is reinstated rather than a new one created — the returned id will match the original owner's id.

post/v1/businesses/{client_id}/budgets/{budget_id}/owners

Path parameters

client_idinteger required
Example:123

The ID of the business.

budget_idstring required

The ID of the budget.

Request body

OR

Example request

{
  "user": {
    "id": 123
  },
  "invite": {
    "id": "e33b7c61-5124-4ba0-b238-e4c573133715"
  }
}

Response

Created

idstring

The ID of the budget owner.

is_deletedboolean

Whether the budget owner has been removed from the budget.

createdstring date-time

The date and time when the budget owner was created in UTC.

updatedstring date-time

The date and time when the budget owner was last updated in UTC.

Example response

{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "user": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "name": "John Doe"
  },
  "invite": {
    "id": 99,
    "email": "jane.doe@example.com",
    "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "role": "Team Member",
    "payment_types": [
      "cards",
      "reimbursements"
    ],
    "created": "2026-05-01T00:00:00Z",
    "updated": "2026-05-01T00:00:00Z"
  },
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z"
}