Skip to main content
PATCH
Update a project's name, budget cap, or enforcement mode

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string<uuid>
required

The project (child org) id.

Body

application/json
name
string
Required string length: 1 - 80
monthlyCredits
integer | null

Number sets the cap, explicit null clears it, omitted leaves it alone.

Required range: 1 <= x <= 100000000
enforcement
enum<string>

hard blocks new spend once the monthlyCredits cap is reached; soft tracks spend against the cap without blocking. Omitting the field leaves the current value unchanged.

Available options:
hard,
soft

Response

The updated project.

A project is a child org under the parent (agency) org: a customer's own isolated set of workspaces/tables while credits and the concurrency pool stay shared at the parent. Select it on any non-/projects request via the x-origami-project header.

object
string
required
Allowed value: "project"
id
string<uuid>
required
name
string
required
monthlyCredits
number | null
required

Monthly budget cap in credits, or null when uncapped.

Required range: 1 <= x <= 100000000
enforcement
enum<string> | null
required

How the monthlyCredits cap is enforced - hard blocks new spend once the cap is reached, soft only tracks. null when the project is uncapped (nothing to enforce).

Available options:
hard,
soft
usage
object
required

This billing period's settled spend plus live in-flight reservations attributed to the project, in credits; the same numbers the in-app Teams page shows.

createdAt
string<date-time>
required