Update Family
Patch a family's name, description and/or notification settings (the editor's Form settings → Details panel).
Only the fields the caller actually sent are written, so patching the description never clobbers the name. An empty/whitespace description is stored as NULL (the same "no description" the list renders as blank); an empty name is rejected, since a family must always be nameable.
Authorization
OrgApiKey Organization API key. Send as Authorization: Bearer <key>. Create one in Admin > Settings > API keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Partial update. Every field is optional so a caller can patch one without resending the
others; the route reads model_fields_set to tell "omitted" from "explicitly set to null"
(description is nullable, so {"description": null} must clear it).
Response Body
application/json
application/json
curl -X PATCH "https://example.com/templates/families/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "current_version_id": "158beffb-f9de-457f-bbee-873740e72504", "requires_approval": false, "requires_sign_off": false, "archived_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tags": [], "settings": {}}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string", "input": null, "ctx": {} } ]}