Skip to main content
PATCH
Update an ai snippet

Authorizations

x-api-key
string
header
required

Path Parameters

aiSnippetId
string
required
Minimum string length: 1

Body

application/json
name
string
Minimum string length: 1
description
string | null
toneId
string
Minimum string length: 1
model
string
Minimum string length: 1
outputLength
integer
Required range: 0 <= x <= 10
prompt
string

Plain prompt text. Placeholders: {fieldId} for contact/company/CRM/formula/notes fields (discover via the contact/company field-metadata endpoints), {aiResearch:<id-or-name>}, {aiSnippet:<id-or-name>}, {aiMessage:<id-or-name>} for AI entity references. Validation is strict: unknown or ambiguous tokens return 400 with the invalid tokens and a sample of valid ones. Escape literal braces by doubling them ({{ and }}).

fallbackText
string | null
folderId
number | null
customPromptFieldValues
object[]

Response

AI snippet updated successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object