Sign in
latestOpenAPI 3.0.32026-08-23640164.5 KB

1d888a894943

Writing Styles

Create a new writing style (status: PENDING). Populate dos and donts now or later via PATCH /public/v1/writing-styles/:id. A writing style needs rules before it can be linked to a campaign.

Required: workspaceId, name

Optional: dos, donts, connectInstructions, inmailInstructions, qna, templateName, templateFollowUpConfig, accessScope

accessScope:

  • OWNER (default) — private to the authenticated user
  • WORKSPACE — shared across the workspace; only ADMIN or OWNER members can set this
post/public/v1/writing-styles

Request body

workspaceIdstring required

ID of the workspace to create the writing style in.

namestring required

Display name for the writing style.

dosstring[]

List of things the AI should do when writing in this style.

dontsstring[]

List of things the AI should avoid when writing in this style.

connectInstructionsstring

Type any custom instructions here — tone preferences, message length guidelines, personalization rules, or any other direction for how your connect sequences should be written.

inmailInstructionsstring

Type any custom instructions here — tone preferences, message length guidelines, personalization rules, or any other direction for how your InMail sequences should be written.

templateNamestring

Optional template label (e.g. "Executive", "Startup") used to categorise the style.

accessScope'OWNER' | 'WORKSPACE'

Who can use this writing style. OWNER = private to you; WORKSPACE = shared across the workspace (ADMIN/OWNER only).

Response

Default Response

statusCodenumber
statusboolean
messagestring