Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

Create organization member journal entry

Creates a new journal entry for an organization member (external contact).

What you need to provide:

  • memberId (required): UUID of the organization member this entry is about
  • body (required): Rich text content in HTML or Markdown format. Supports:
    • Headings, paragraphs, lists, and formatting
    • Links and embedded content
    • The content is automatically converted to the internal document format
  • mood (optional): Emotional indicator - Happy, Neutral, or Sad (defaults to Neutral)
  • reminder (optional): ISO 8601 date string for follow-up reminders (e.g., “2024-12-31”)

Access control:

  • Users with Organizations.writeJournal permission can create entries for any member
  • Organization members can create entries for their own member record
  • The memberId must exist and be accessible to the current user
  • Returns 400 if the member does not exist or is not accessible

Visibility behavior:

  • If the user is creating an entry for their own member record, visibleToSubject is automatically set to true
  • If the user has Organizations.writeJournal permission and creates an entry for another member, visibleToSubject is set to false (internal only)

What is returned: The complete journal entry with all fields, including the body converted to HTML format and timestamps.

POST/organizations/members/journal
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
fieldsToReturnstring
Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.
responseShapestring
Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
Allowed:compactfull
Header parameters
LT-Response-Shapestring
Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
Allowed:full
Request body
requiredapplication/json
bodystringrequired
Rich text content for the journal entry in HTML or Markdown format. The content is automatically converted to the internal document format (IDoc) for storage. Supports headings, paragraphs, lists, links, and formatting. Accepts Markdown or HTML for complex formatting. This content is rendered by the Leadtime rich editor, not by a plain Markdown viewer. For quick/simple text, Markdown is acceptable. For polished user-facing content from an agent or integration, prefer structured HTML because it preserves editor blocks, links, and layout more predictably. Use only the nodes and marks documented below for this field. Supported editor features differ by endpoint and field. Choose formatting for readability, not decoration: use headings for real sections, paragraphs for narrative text, lists or tables for structured facts, blockquotes for quoted context, callouts for important outcomes/risks/notes when supported, and explicit anchors for links. Do not rely on bare URLs or Markdown links when the link must be clickable; use explicit anchors such as <a href="https://example.com" target="_blank" rel="noopener noreferrer nofollow">link text</a>. In HTML you can use: ## Node Types and Marks ### Nodes **paragraph** Type: block Content: inline* (inline only — do not use block tags such as <p> inside; use e.g. <br>, <strong>, <em>, <span>…) Default paragraph. extraPlaceholder is an internal structure for the editor to show a ghost placeholder in empty “template” lines (ProseMirror JSON fragment or null). For normal agent output leave extraPlaceholder as null. Only set it if you are intentionally mirroring a field placeholder the user already has in the open editor; do not set random placeholder data for free-form answers. Atts: - extraPlaceholder: null ```html <p class="paragraph-base" extraplaceholder="null/some-value"></p> ``` **heading** Type: block Content: inline* (inline only — do not use block tags such as <p> inside; use e.g. <br>, <strong>, <em>, <span>…) Atts: - level: 1 ```html <h1 class="heading-base"></h1> ``` **bulletList** Type: block list Content: listItem+ Atts: none ```html <ul class="list-base"><li></li></ul> ``` **hardBreak** Type: inline Atts: none ```html <br> ``` **horizontalRule** Type: block Atts: none ```html <hr class="hr-base"> ``` **orderedList** Type: block list Content: listItem+ Atts: - start: 1 - type: null ```html <ol class="order-list-base" type="null/some-value"><li></li></ol> ``` **listItem** Content: (paragraph|list)* (paragraphs and/or lists, in any order) Atts: none ```html <li></li> ``` **blockquote** Type: block Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Atts: none ```html <blockquote class="blockquote-base"><p class="paragraph-base"></p></blockquote> ``` **table** Type: block Content: tableRow+ Atts: none ```html <table style="width: 0px;"><colgroup></colgroup><tbody><tr></tr></tbody></table> ``` **tableRow** Content: (tableCell | tableHeader)* Atts: none ```html <tr></tr> ``` **tableHeader** Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Atts: - colspan: 1 - rowspan: 1 - colwidth: null - align: null ```html <th colspan="1" rowspan="1" colwidth="null/some-value" style="text-align: null/some-value;"><p class="paragraph-base"></p></th> ``` **tableCell** Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Atts: - colspan: 1 - rowspan: 1 - colwidth: null - align: null ```html <td colspan="1" rowspan="1" colwidth="null/some-value" style="text-align: null/some-value;"><p class="paragraph-base"></p></td> ``` **callout** Type: block Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Callout / info box. The icon attr is an emoji shortcode (e.g. :information_source:, :warning:); it appears on the callout. Body is block content (paragraphs, lists, etc.) — use normal block HTML such as <p class="paragraph-base"> inside the callout <div>. data-type is "callout". Atts: - icon: :information_source: ```html <div data-type="callout" icon=":information_source:"><p class="paragraph-base"></p></div> ``` **appImage** Type: block Block for an image file already uploaded in Leadtime. - fileId: Id of the stored image. Must be a real uploaded file; do not invent. - filename: Display name; should match the file. - width, align, size: Layout as in the editor. If no file id is available, obtain one via upload/API before outputting this node with a fake id. Atts: - fileId: - filename: - width: 500 - align: left - size: 0 ```html <div data-type="appImage" fileid="" filename="" width="500" align="left" size="0"></div> ``` **collapse** Type: block Content: collapseTitle collapseBody (a collapse title node, then a collapse body) Expandable/collapsible section. Required structure: one collapseTitle (summary, inline) then one collapseBody (blocks) as direct children, matching data-type= collapseTitle / collapseBody tags under <collapse>. Do not use title/body nodes outside of a collapse. Atts: none ```html <collapse><collapse-title></collapse-title><collapse-body><p class="paragraph-base"></p></collapse-body></collapse> ``` **collapseBody** Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Expandable body of a collapse. Only use as sibling of collapseTitle inside a collapse; holds the block content that shows when expanded. Atts: none ```html <collapse-body><p class="paragraph-base"></p></collapse-body> ``` **collapseTitle** Content: inline* (inline only — do not use block tags such as <p> inside; use e.g. <br>, <strong>, <em>, <span>…) Clickable title row of a collapse block. Only use inside a collapse that also has collapseBody; content is the summary line shown when collapsed. Atts: none ```html <collapse-title></collapse-title> ``` **emoji** Type: inline Inline emoji. icon is a colon shortcode (e.g. :thumbsup:, :white_check_mark:) stored in data-icon; body is often empty. Use names your emoji set supports; avoid inventing invalid shortcodes in final HTML if you need them to render. Atts: - icon: :smile: ```html <span data-type="emoji" data-icon=":smile:"></span> ``` ### Marks **link** Atts: - href: null - target: _blank - rel: noopener noreferrer nofollow - class: null - title: null ```html <a target="_blank" rel="noopener noreferrer nofollow" href="">link text example</a> ``` **bold** Atts: none ```html <strong>bold text example</strong> ``` **code** Atts: none ```html <code>code text example</code> ``` **italic** Atts: none ```html <em>italic text example</em> ``` **strike** Atts: none ```html <s>strike text example</s> ``` **underline** Atts: none ```html <u>underline text example</u> ``` Use this field to document conversations, observations, agreements, or any notes about the organization member.
memberIdstringrequired
UUID of the organization member (external contact) this journal entry is about. The member must exist in the workspace and be accessible to the current user. Organization members can only create entries for their own member record unless they have the `Organizations.writeJournal` permission.
moodstring
Emotional indicator for the journal entry. Use this to quickly categorize the tone or sentiment of the interaction. Options: `Happy` (positive interaction), `Neutral` (standard/neutral interaction), or `Sad` (negative or concerning interaction). Defaults to `Neutral` if not provided. This helps filter and analyze journal entries by emotional context.
Allowed:SadNeutralHappy
reminderstring
Optional reminder date in ISO 8601 format (YYYY-MM-DD). Use this to set a follow-up date for reviewing goals, agreements, or taking action related to this journal entry. The reminder date can be used to filter entries and trigger notifications. Example: "2024-12-31" for December 31, 2024. If not provided, no reminder is set.
Responses
200
bodystringrequired
Journal entry content in HTML format. The content is automatically converted from the internal document format (IDoc) to HTML for easy display in web applications. Contains the rich text content including headings, paragraphs, lists, links, and formatting as originally provided.
createdAtstringrequired
ISO 8601 timestamp indicating when this journal entry was created. Format: YYYY-MM-DDTHH:mm:ssZ (e.g., "2024-01-15T10:30:00Z").
createdBystringrequired
UUID of the user who created this journal entry. This identifies who wrote the entry, which is useful for tracking authorship and accountability.
idstringrequired
Unique identifier (UUID) for this journal entry
lastUpdatedstringrequired
ISO 8601 timestamp indicating when this journal entry was last modified. Format: YYYY-MM-DDTHH:mm:ssZ (e.g., "2024-01-16T14:20:00Z"). This is automatically updated whenever the entry is edited via the PATCH endpoint.
memberIdstringrequired
UUID of the organization member (external contact) this journal entry is associated with. This identifies which external contact the entry is about.
moodstringrequired
Emotional indicator for the journal entry. Values: `Happy` (positive interaction), `Neutral` (standard/neutral interaction), or `Sad` (negative or concerning interaction). This helps categorize and filter entries by emotional context.
Allowed:SadNeutralHappy
reminderobject | nullrequired
Optional reminder date in ISO 8601 format (YYYY-MM-DD). Set when creating or updating the entry to track follow-up dates for goals, agreements, or actions. Returns `null` if no reminder is set. Example: "2024-12-31" for December 31, 2024.
400Validation errors or member not accessible
errorsobject
messagestring
statusCodenumber
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X POST "https://leadtime.app/api/public/organizations/members/journal" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "<h1>Member Update</h1><p>Had a productive meeting today. Discussed project timeline and next steps.</p>",
  "memberId": "550e8400-e29b-41d4-a716-446655440000",
  "mood": "Neutral",
  "reminder": "2024-12-31"
}'
Response
{
  "body": "<h1>Member Update</h1><p>Had a productive meeting today. Discussed project timeline and next steps.</p>",
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lastUpdated": "2024-01-16T14:20:00Z",
  "memberId": "550e8400-e29b-41d4-a716-446655440000",
  "mood": "Neutral",
  "reminder": "2024-12-31"
}