Communication Records

PATCH /communication-records/{id}

Changed on

PATCH operation for /communication-records/{id}

patch/communication-records/{id}

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/communication-records/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Request body

idinteger
created_atstring date-time
modified_atstring date-time
titlestring required
context_filter_namestring

Snapshot of the filter name at score time (preserved if filter is deleted).

companystring required
projectstring
data_sourcestring required
ownerstring required
owner_userstring
owner_restriction'standard' | 'restricted' | 'fully_restricted'

Denormalized visibility restriction from the record's owner.

contributorsstring
relevancenumber float
assigned_relevancenumber float

Human-assigned relevance override. Null until a person sets it (the LLM score is never copied here).

datestring required
labelsstring[]
peoplestring[]
companiesstring[]
projectsstring[]
urgency'low' | 'medium' | 'high'

How time-sensitive the communication is, judged per record by the LLM ('' = not assessed).

summarystring
notesstring
sizeinteger

Size in kilobytes (KB).

folderstring
token_usageinteger

Total OpenAI tokens used to score this record against its context filter.

recording_urlstring
linkstring
connection_modestring
source_textstring
mcp_availableboolean

Made available in the Onboard MCP (met the Make-Available threshold).

collaborator_idsstring

Response

Successful response

idinteger
created_atstring date-time
modified_atstring date-time
titlestring required
context_filter_namestring

Snapshot of the filter name at score time (preserved if filter is deleted).

companystring required
projectstring
data_sourcestring required
ownerstring required
owner_userstring
owner_restriction'standard' | 'restricted' | 'fully_restricted'

Denormalized visibility restriction from the record's owner.

contributorsstring
relevancenumber float
assigned_relevancenumber float

Human-assigned relevance override. Null until a person sets it (the LLM score is never copied here).

datestring required
labelsstring[]
peoplestring[]
companiesstring[]
projectsstring[]
urgency'low' | 'medium' | 'high'

How time-sensitive the communication is, judged per record by the LLM ('' = not assessed).

summarystring
notesstring
sizeinteger

Size in kilobytes (KB).

folderstring
token_usageinteger

Total OpenAI tokens used to score this record against its context filter.

recording_urlstring
linkstring
connection_modestring
source_textstring
mcp_availableboolean

Made available in the Onboard MCP (met the Make-Available threshold).

collaborator_idsstring

Changes

  • c64f0cb20b75Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response's property format changed from date to no format for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request optional property became not read-only

    • info

      the request optional property became not read-only

    • info

      the request optional property became not read-only

    • info

      the request optional property became not read-only

    • info

      the request property became optional

    • info

      the request property format was generalized from date to no format

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property became not read-only for the status