Skip to main content
PUT
Update AI function

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

AI function id. Get it from aiFunctions.list.

Pattern: ^\d+$

Body

application/json
name
string
required

AI function name.

Minimum string length: 1
dataCollect
object[]
required

Field mappings collecting model output into contact/custom fields.

purpose
string | null

Description of when the model should call this function.

outputMessage
string | null

Message sent to the contact after this function runs.

triggerFlowId
string | null

Flow id (numeric string) to start after this function runs.

Pattern: ^\d+$

Response

OK

id
string
required
Pattern: ^\d+$
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
name
string
required
purpose
string | null
required
dataCollect
required
outputMessage
string | null
required
workspaceId
string
required
Pattern: ^\d+$
triggerFlowId
unknown