outreach
outreach

Preview Outreach Message

Generate a preview message without saving to history. Supports state-based, custom, or ad-hoc prompts with model selection.

post/api/outreach/preview/{person_id}

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/preview/{person_id}
  • Auth: none declared

Path parameters

person_idinteger required

Request body

message_type'llm' | 'template'
template_textstring nullable
prompt_source'state' | 'custom' | 'adhoc'
prompt_idinteger nullable
statestring nullable
adhoc_promptstring nullable
modelstring nullable
temperaturenumber nullable

Response

Successful Response

successboolean required
messagestring nullable
contact_namestring required
contact_statestring nullable
context_usedobject nullable
prompt_usedstring nullable
errorstring nullable

Changes

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