POST
/
v1
/
teams
/
{teamId}
/
team-memory
/
entries
/
{entryId}
/
retract
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.teamMemory.retractTeamMemoryEntry({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  entryId: process.env.OCTOSPARK_ENTRY_ID ?? "entryId",
  body: {},
})
{
  "retractionEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

entryId
string
required

Team memory entry id (UUID), as returned by the list, append and search team memory endpoints.

Body

application/json
reason
string
required

Why, in 1-500 characters. Recorded in the change log.

Required string length: 1 - 500

Response

RetractTeamMemoryEntryResponse

retractionEntryId
string<uuid>
required

The retraction note entry that was appended.

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}$
relationId
string<uuid>
required

The retracts relation that was appended.

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}$