Project Settings API
A project's settings are its per-project knobs: how long a sprint runs and on which days, which timezone its deadlines are read in, what work is sized in and on which scale, who a new item goes to, whether pull requests move items along and whether checklists gate a sprint or a done, whether a client guest may comment, whether Heimdall assists, where alerts go on Telegram, the board's limits and hidden columns, the business hours SLAs count and whether a production outage opens an incident.
A project's settings are its per-project knobs: how long a sprint runs and on which days, which timezone its deadlines are read in, what work is sized in and on which scale, who a new item goes to, whether pull requests move items along and whether checklists gate a sprint or a done, whether a client guest may comment, whether Heimdall assists, where alerts go on Telegram, the board's limits and hidden columns, the business hours SLAs count and whether a production outage opens an incident. A project stores only the keys somebody changed; the read answers every key with the workspace default filled in.
The read is for staff: a project's settings are the team's business, so a client guest's token is refused with a 403 FORBIDDEN even though the guest may read the project. The write runs the same action the project's Settings page runs, under project:update, and announces the keys that changed as project.settings_changed.
Endpoints
/v1/projects/{project}/settingsGet a project's settingsPATCH/v1/projects/{project}/settingsUpdate a project's settingsRelated
How is this guide?
Last updated on