Save Team Rules
set-team-rulesSaves the Markdown rules the user approved as their Better Design team's rules, or, given a client project, one piece of it: its guidelines, a use, never or pairing rule for one part, a brand-wide ban, or a spec on a screen. It refuses to replace different saved text unless the user agreed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | With projectId: "guidelines", "use", "never", "pairing" or "spec". A screen alone means spec; nothing at all means guidelines; a part needs its kind. | |
| part | No | With projectId: the part or value the rule or spec is about, such as "Button" or "--primary". | |
| screen | No | With projectId: the screen a spec belongs to, such as "sign-up". | |
| markdown | Yes | The whole rules document in Markdown, in the outline get-team-rules gives, or one project piece. Up to 32 KB for team rules or project guidelines, 4 KB for a part rule or spec. | |
| projectId | No | Save into this client project instead of the account's team rules. The project must belong to this account. | |
| personApproved | Yes | True only after the person read this exact draft and said to save it. | |
| replaceExisting | No | True only after the person agreed to replace the rules already saved. |