Projects

Change one character's notes.

Changes ONE person's notes: name them by character (any name the cast canon knows them by) or by the card's id. Only the fields sent change; null or "" clears one, and a card left with nothing in it is removed (character: null in the answer). A person with no notes yet gets a card under their cast canon name. The same notes their card on the project's Cast page shows. Free. Scope: story:write.

patch/story-projects/{projectId}/character-notes

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/character-notes
  • Auth: HTTP bearer

Request body

characterstring

The person, by any name the cast canon knows them by.

idstring

The notes card's id, instead of (or with) character.

rolestring nullable

Their role in the story. null or "" clears it; omitted leaves it alone.

wantstring nullable

What they want. null or "" clears it; omitted leaves it alone.

obstaclestring nullable

What gets in the way. null or "" clears it; omitted leaves it alone.

arcstring nullable

How they change. null or "" clears it; omitted leaves it alone.

relationshipsstring nullable

Who matters to them. null or "" clears it; omitted leaves it alone.

voicestring nullable

How they talk. null or "" clears it; omitted leaves it alone.

notesstring nullable

Anything else. null or "" clears it; omitted leaves it alone.

Response

The notes as saved.

projectIdstring required
currentVersioninteger required
updatedAtstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.