Skip to main content

The value an AI custom field's prompt produced for one contact. Nothing is written to the contact.

customFieldId
integer
required

The custom field the prompt belongs to.

contactId
integer
required

The contact the prompt was resolved against.

status
enum<string>
required

Outcome of the run. missingData means the contact does not carry a template variable the prompt refers to; noResults means the prompt produced nothing.

Available options:
succeeded,
failed,
missingData,
noResults
value
string | null

The generated value, or null when status is anything other than succeeded.

errorMessage
string | null

Explains any status other than succeeded; null otherwise.