Delete a scenario budget by external ID

DELETE

/scenarios/{scenario_id}/budgets/external/{external_id}/

curl --request DELETE \
  --url https://app.commitly.com/api/scenarios/12459/budgets/external/ext-123457/ \
  --header 'Authorization: Bearer <token>'

• Production

Deletes the budget with the given external_id from the given scenario.

Note: Budgets of a committed plan cannot be updated or deleted (403). Other checks that the COMMITLY app applies may not apply to the API. Only delete budgets that your integration created, for example by filtering on external_source (list parameter source).

Authorizations

• commitlyOAuth

Parameters

Path Parameters

scenario_id

required

integer

Scenario ID (id of a plan with type SCENARIO from GET /plans/).

Example

12459

external_id

required

string

The external_id set when the budget was created. Budgets whose external_id contains . or / cannot be addressed by this path. The trailing slash after the external_id is required.

Example

ext-123457

Responses

204

Budget deleted.

401

The access token is invalid or has expired. Request a new token. The message is localized (see Accept-Language).

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "Invalid token."
}

Headers

WWW-Authenticate

string

Authentication scheme, Bearer.

Example

Bearer

403

No access token was sent, or the credentials are not allowed to call this endpoint. If the company’s COMMITLY edition does not include the requested function, the body additionally contains "code": "billing_plan_permission_denied".

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "User must be authenticated to access this resource."
}

404

The resource does not exist or is not accessible with these credentials.

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example^generated

{
  "detail": "example",
  "code": "example"
}