Skip to main content

ExecModuleAudienceConfig

Description

Properties

NameTypeDescriptionNotes
basePathStringBase URL for the API service (defaults to VALKYR_BASE_PATH env var or http://localhost:8080)[optional]
bccStringDefault BCC recipients[optional]
bodyStringSMS message body (max 1600 characters)[optional]
ccStringDefault CC recipients[optional]
channelStringSlack channel ID or name (e.g., #general, C1234567890)[optional]
channelAccountIdStringChannelAccount UUID for platform credentials[optional]
channelIdStringDiscord channel ID where message will be posted[optional]
conditionStringBoolean condition expression to evaluate[optional]
createContactBooleanWhether to create a contact if not found[optional]
defaultCampaignIdStringDefault campaign to enroll contacts into[optional]
defaultListIdsList<ArrayStringItem>List UUIDs to add contact to by default[optional]
defaultTagsList<ArrayStringItem>Tag UUIDs to apply to contact by default[optional]
falsePathStringTask ID or workflow path to execute if false[optional]
forecastHorizonIntegerNumber of periods to forecast (default 12)[optional]
fromPhoneStringSender phone number (must be Twilio-verified)[optional]
imageUrlStringImage URL to publish[optional]
includeRevenueBooleanWhether to compute revenue attribution[optional]
includeScoreBandTagsList<ArrayStringItem>Score bands to include: ['warm', 'hot', 'vip'][optional]
inviteeEmailStringInvitee email address[optional]
iterationsBigDecimalNumber of times to loop[optional]
linkStringLink URL to share[optional]
listIdStringList UUID to resolve contacts from[optional]
llmServiceIdStringUUID of the LLM service to use for summarization[optional]
lookupKeysList<ArrayStringItem>Fields to use for contact lookup[optional]
maxBatchSizeIntegerMaximum number of posts to return[optional]
maxMessagesBigDecimalMaximum number of recent messages to include in summary[optional]
maxResultsIntegerMaximum results to return[optional]
meetingIdStringMeeting ID to retrieve (required for getMeeting)[optional]
mergeStrategyStringContact merge strategy: 'email_only', 'email_and_phone', 'any_match'[optional]
modelStringImage generation model to use[optional]
numCandidatesIntegerNumber of subject line variations to generate[optional]
openAiModelStringOpenAI model to use[optional]
openapiUrlStringURL to the OpenAPI spec file[optional]
operationsList<ArrayStringItem>Cleaning operations to apply[optional]
orderIdStringSalesOrder UUID to create checkout session for[optional]
pageIdStringFacebook Page ID to post to[optional]
percentilesList<ArrayStringItem>Percentiles to compute[optional]
photoUrlStringPhoto URL to attach[optional]
principalUsernameStringUsername of the principal whose messages to index[optional]
quoteTweetIdStringTweet ID to quote[optional]
replayTargetModuleStringReplay Target Module configuration parameter[optional]
replyToStringDefault reply-to address[optional]
replyToTweetIdStringTweet ID to reply to[optional]
s3BucketStringTarget S3 bucket for the PDF.[optional]
s3KeyPrefixStringPrefix to prepend to generated S3 keys.[optional]
s3RegionStringAWS region of the target bucket.[optional]
saveSnapshotBooleanWhether to persist a ContactScoreSnapshot[optional]
scoreModelIdStringID of ContactScoreModel to use for scoring[optional]
targetStringTarget configuration parameter[optional]
toPhoneStringRecipient phone number (E.164 format: +1234567890)[optional]
trackLinksBooleanWhether to add tracking parameters to links[optional]
truePathStringTask ID or workflow path to execute if true[optional]
updateFrequencyIntegerTarget network update frequency (default 5)[optional]
websocketTopicStringSTOMP topic to publish to when the ws channel is enabled.[optional]
idUUIDUnique identifier for object in the system[optional] [readonly]
ownerIdUUIDUUID of owner of the object in the system[optional] [readonly]
createdDateOffsetDateTimeDate of object creation[optional] [readonly]
keyHashStringData, including hash of the key(s) used to encrypt this record.[optional] [readonly]
lastAccessedByIdUUIDLast user to access object[optional] [readonly]
lastAccessedDateOffsetDateTimeTimestamp of last access of object[optional] [readonly]
lastModifiedByIdUUIDUnique identifier for user who last modifed the object in the system[optional] [readonly]
lastModifiedDateOffsetDateTimeDate of last object modification[optional] [readonly]
trashedBooleanIndicates if the object is trashed (soft deleted)[optional]

Implemented Interfaces

  • Serializable

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.2-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2026-04-02T00:49:23.764634-07:00[America/Los_Angeles]