POST
/
v1
/
teams
/
{teamId}
/
posts
/
{postId}
/
notes
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.postNotes.createPostNote({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  postId: process.env.OCTOSPARK_POST_ID ?? "postId",
  body: {},
})
{
  "mentionedUserIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "postId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "body": "<string>",
  "bodyDoc": [
    "<unknown>"
  ],
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authorName": "<string>",
  "authorEmail": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

​
postId
string
required

Post id (UUID), as returned by the create post and list posts endpoints.

Body

application/json
​
mentionedUserIds
string<uuid>[]

User ids mentioned in the body, in the order they were inserted. Up to 20; ids outside the owning team are ignored.

Maximum array length: 20

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
body
string

Plain-text mirror of the note, used for search and previews. Up to 10,000 characters. Keep it in sync with bodyDoc.

Maximum string length: 10000
​
bodyDoc
any[] | null

Rich (block-based) note document, stored verbatim for the notes editor. Send null to clear it; keep the plain-text body field in sync.

Response

Success

​
mentionedUserIds
string<uuid>[]
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
teamId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
postId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
body
string | null
required
​
bodyDoc
any[] | null
required
​
createdBy
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
authorName
string | null
required
​
authorEmail
string | null
required
​
createdAt
string
required
​
updatedAt
string
required