Creating a new formula

POST /api/v1/formulas

Creates a new formula and persists it to the database.

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

Permission: Permissions.FORMULAS_FORMULA_CREATE


Request

Request Body

{
  "name": "Carbon Credit Calculator",
  "description": "Calculates carbon credits based on emission factors",
  "policyId": "63e3e5e8a01b3c001234abcd",
  "config": {}
}
Field
Type
Required
Description

name

string

Yes

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

Formula expression configuration


Response

Success Response

Status: 201 Created

Error Responses

Status
Description

400 Bad Request

Malformed request body

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

422 Unprocessable Entity

Missing or invalid formula configuration

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?