Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Authenticate with a workspace-pinned Floral personal access token.

Headers

X-Request-ID
string

Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.

Required string length: 1 - 128
If-Match
string
required

Strong ETag from the latest detail or mutation response. A stale value returns 412 VERSION_CONFLICT.

Pattern: ^"(?:[^"\\]|\\.)*"$

Path Parameters

workspaceSlug
string
required

Slug of the workspace pinned to the credential.

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
id
integer
required

Stable numeric resource ID.

Required range: x >= 1

Body

application/json

Only internalNotes is accepted. Whitespace-only notes are stored as null. Maximum 65536 bytes.

internalNotes
string | null
required
Maximum string length: 50000

Response

Summary notes updated

summary
object
required