Create a project objective

Projects module

POST/project-objectivesprojectObjectives.create

A measurable objective recorded at gate 1 (canon criterion G1.OBJECTIVES_STATED): one target per metric and project, which gate 8 measures against. Once gate 1 is passed only a gate approver (projects.gate.transition) sets, changes or withdraws one; every change is in the audit ledger. Creates a project objective. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability projects.gate.evidence.write.
OAuth scopes: projects.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ProjectObjectiveCreate

projectObjectives.create: ProjectObjectiveCreate
Field	Type	Required	Description
project_id	string (uuid)	Yes	Identifier of the project.
metric_code	string	Yes	Metric (app.measurement_metrics).Constraints: pattern ^[a-z][a-z0-9_]*$
direction	"At Least" \| "At Most"	Yes	Met by reaching the target (At Least) or by staying within it (At Most).
target_value	number	Yes	Target figure, in unit_code.
unit_code	string	Yes	Unit of the target, of the metric's dimension.Constraints: pattern ^[a-z][a-z0-9_]*$
note	string \| null	No	Note.Constraints: length 1 to 2000

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "metric_code": "waste_generated",
  "direction": "At Most",
  "target_value": 2,
  "unit_code": "kg",
  "note": "Two roll-off containers."
}

Response 201: ProjectObjective

projectObjectives.create: ProjectObjective
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the project objective.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row.
project_id	string (uuid)	Yes	Identifier of the project.
metric_code	string	Yes	Metric (app.measurement_metrics).Constraints: pattern ^[a-z][a-z0-9_]*$
direction	"At Least" \| "At Most"	Yes	Met by reaching the target (At Least) or by staying within it (At Most).
target_value	number	Yes	Target figure, in unit_code.
unit_code	string	Yes	Unit of the target, of the metric's dimension.Constraints: pattern ^[a-z][a-z0-9_]*$
note	string \| null	Yes	Note.Constraints: length 1 to 2000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "metric_code": "waste_generated",
  "direction": "At Most",
  "target_value": 2,
  "unit_code": "kg",
  "note": "Two roll-off containers."
}

Code samples

curl -X POST "$XOS_BASE_URL/project-objectives" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","metric_code":"waste_generated","direction":"At Most","target_value":2,"unit_code":"kg","note":"Two roll-off containers."}'

const { data } = await xos.projectObjectives.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "metric_code": "waste_generated",
    "direction": "At Most",
    "target_value": 2,
    "unit_code": "kg",
    "note": "Two roll-off containers."
  });

response = xos.project_objectives.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "metric_code": "waste_generated", "direction": "At Most", "target_value": 2, "unit_code": "kg", "note": "Two roll-off containers."})

xos project-objectives create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","metric_code":"waste_generated","direction":"At Most","target_value":2,"unit_code":"kg","note":"Two roll-off containers."}'