Update the formula by its ID

PUT /api/v1/formulas/{formulaId}

Updates the configuration of an existing formula for the specified formula ID.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.FORMULAS_FORMULA_CREATE


Request

Path Parameters

Parameter
Type
Required
Description

formulaId

string

Yes

Database ID of the formula to update

Request Body

{
  "name": "Updated Carbon Credit Calculator",
  "description": "Updated description",
  "policyId": "63e3e5e8a01b3c001234abcd",
  "config": {}
}
Field
Type
Required
Description

name

string

No

Human-readable formula name

description

string

No

Description of the formula's purpose

policyId

string

No

ID of the policy this formula is linked to

config

object

No

Updated formula expression configuration


Response

Success Response

Status: 200 OK

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

404 Not Found

Formula with the given ID does not exist

422 Unprocessable Entity

formulaId parameter is missing or empty

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?