Browse the API reference

Object

Campaign

View as Markdown

Fields

  • idstringrequired
  • organization_idstringrequired
  • namestringrequired
  • assistant_idstringrequired
  • assistantAssistant
  • from_phone_numberstringnullable
  • max_concurrent_callsnumbernullable
  • scheduled_atanynullable
  • call_retry_configCallRetryConfignullable
  • statusenum (string)required

    One ofrunningpausedcompleted

  • is_cancelledbooleanrequired
  • structured_output_extractionenum (string)

    The status of the structured output extraction.

    One ofnonerunningcompleted

  • row_statsobject
    Show 8 fields
    • not_launchednumberrequired
    • skippednumberrequired
    • pendingnumberrequired
    • callingnumberrequired
    • retrynumberrequired
    • completednumberrequired
    • failednumberrequired
    • totalnumberrequired
  • metadata_keysarray of string
  • funnel_statsobject
    Show 3 fields
    • total_leadsnumberrequired
    • hotnumberrequired
    • talked_to_humannumberrequired
  • created_byOrgMembernullable
  • created_atanyrequired
  • updated_atanyrequired