Sign in
Project Editing

Add Knowledge Base Entry

Add a new knowledge base entry to a project. Requires project:write permission.

post/v1/projects/{projectId}/knowledge-base

Path parameters

projectIdstring required

Project ID (MongoDB ObjectId)

Request body

titlestring required

Title of the knowledge base entry

contentstring required

Content of the knowledge base entry. Stored content is capped at 15,000 characters; anything longer is truncated with a note.

previewHtmlstring

Rendered HTML of the entry, kept as its preview. Send this for an uploaded email so it can be shown and used as a design reference.

thumbnailUrlstring

URL of a thumbnail image for the entry.

screenshotUrlstring

URL of a full screenshot of the entry.

referenceOrigin'favorite' | 'upload' | 'manual'

Marks the entry as a design reference the email writer should learn from, and records where it came from. Omit for an ordinary note — an entry without it is never treated as a reference.

Response

Knowledge base entry added

successboolean required
errorstring nullable

Changes