Skip to main content

accept-budget-suggestion 

dci accept-budget-suggestion <id> [body]

Marks the suggestion as accepted and links it to an existing budget. Create the budget first via POST /analytics/v1/budgets, then pass its id as budgetId. The budget must belong to your account.

  • id — Budget suggestion ID as shown by dci list-budget-suggestions (select it with -C id,name).

Pass the request body as name: value arguments or pipe JSON on stdin — see Command structure.

Create the budget first

Accepting does not create a budget. Run dci create-budget with the suggested shape (amount, interval, scope), then pass the new budget's id as budgetId. The budget must belong to your account.

Examples​

# Link a suggestion to the budget you created from it.
dci accept-budget-suggestion <budget-suggestion-id> budgetId: <budget-id>
`{"budgetId": "<budget-id>"}`; the suggestion leaves the pending list.
# Record that you changed the suggested values before accepting.
dci accept-budget-suggestion <budget-suggestion-id> editedBeforeAccept: true, budgetId: <budget-id>

Request​

Content-Type: application/json

FieldTypeRequiredDescription
budgetIdstringyesID of the budget (created via POST /analytics/v1/budgets) to link this suggestion to.
editedBeforeAcceptbooleanWhether the customer edited the suggested values before accepting.
Raw JSON schema
{
  "type": "object",
  "description": "Links a budget suggestion to an existing budget.",
  "required": [
    "budgetId"
  ],
  "properties": {
    "budgetId": {
      "type": "string",
      "description": "ID of the budget (created via POST /analytics/v1/budgets) to link this suggestion to."
    },
    "editedBeforeAccept": {
      "type": "boolean",
      "description": "Whether the customer edited the suggested values before accepting."
    }
  }
}

Output​

OK - The suggestion was accepted and linked to the budget.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
budgetIdstringID of the budget the suggestion was linked to.
Raw JSON schema
{
  "type": "object",
  "properties": {
    "budgetId": {
      "type": "string",
      "description": "ID of the budget the suggestion was linked to."
    }
  }
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: acceptbudgetsuggestion