Brains

Update a brain

Update a brain's mutable fields, such as its name or description. Omitted fields are left unchanged.

Authentication

x-api-keystring

Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

Path parameters

brainIdstringRequired
Brain id

Headers

x-subject-idstringRequired
Identifies the end user the request is made on behalf of. Brains are owned by a subject, so this determines which brains the caller can see.

Request

This endpoint expects an object.
namestringOptional
New name
descriptionstringOptional
New description

Response

idstring
Brain id
tenantIdstring
Owning tenant id
subjectIdstring

Owning subject id (host-defined)

namestring

User-facing name

slugstring

URL-safe identifier, unique per (tenant, subject)

descriptionstring
Description
briefSettingsobject or null

Daily-brief schedule and delivery settings for this brain.

createdAtdatetime
ISO 8601 timestamp of when this record was created.
updatedAtdatetime
ISO 8601 timestamp of when this record was last modified.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error