outreach
outreach

Create Schedule

Create a new outreach schedule.

post/api/outreach/schedules

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/outreach/schedules
  • Auth: none declared

Request body

namestring required
descriptionstring nullable
target_type'person' | 'group' | 'all_contacts'
person_idinteger nullable
group_idinteger nullable
group_thread_idinteger nullable
message_type'llm' | 'template'
prompt_source'state' | 'custom' | 'adhoc' nullable
prompt_idinteger nullable
prompt_statestring nullable
llm_promptstring nullable
llm_modelstring
template_textstring nullable
template_variablesobject
approval_mode'auto' | 'draft'
schedule_type'one_time' | 'daily' | 'weekly' | 'every_n_days' | 'monthly_day' | 'monthly_weekday' | 'every_n_months' | 'yearly' | 'birthday' required
end_datestring nullable
max_runsinteger nullable
preferred_channelstring nullable
attachment_file_idsinteger[]

Response

Successful Response

idinteger required
namestring required
descriptionstring nullable
message_typestring required
prompt_sourcestring nullable
prompt_idinteger nullable
prompt_statestring nullable
prompt_namestring nullable
llm_promptstring nullable
llm_modelstring nullable
template_textstring nullable
template_variablesobject
approval_modestring required
schedule_typestring required
schedule_configobject
next_run_atstring nullable
last_run_atstring nullable
last_run_statusstring nullable
run_countinteger
success_countinteger
statusstring required
end_datestring nullable
max_runsinteger nullable
preferred_channelstring nullable
attachment_file_idsinteger[]
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 5 revisions of this API.