Create Campaign

POST /api/v1/campaign/create — request parameters and responses from the Menace Voice API schema.

3 min read

post/api/v1/campaign/create

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/campaign/create \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "workflow_id": 1,
  "source_type": "<string>",
  "source_id": "<string>",
  "telephony_configuration_id": 1,
  "retry_config": {
    "enabled": true,
    "max_retries": 2,
    "retry_delay_seconds": 120,
    "retry_on_busy": true,
    "retry_on_no_answer": true,
    "retry_on_voicemail": true
  },
  "max_concurrency": 1,
  "schedule_config": {
    "enabled": true,
    "timezone": "UTC",
    "slots": [
      {
        "day_of_week": 0,
        "start_time": "<string>",
        "end_time": "<string>"
      }
    ]
  },
  "circuit_breaker": {
    "enabled": true,
    "failure_threshold": 0.5,
    "window_seconds": 120,
    "min_calls_in_window": 5
  }
}'

Response

{
  "id": 1,
  "name": "<string>",
  "workflow_id": 1,
  "workflow_name": "<string>",
  "state": "<string>",
  "source_type": "<string>",
  "source_id": "<string>",
  "total_rows": 1,
  "processed_rows": 1,
  "failed_rows": 1,
  "created_at": "2026-08-10T12:00:00Z",
  "started_at": "2026-08-10T12:00:00Z",
  "completed_at": "2026-08-10T12:00:00Z",
  "retry_config": {
    "enabled": true,
    "max_retries": 1,
    "retry_delay_seconds": 1,
    "retry_on_busy": true,
    "retry_on_no_answer": true,
    "retry_on_voicemail": true
  },
  "max_concurrency": 1,
  "schedule_config": {
    "enabled": true,
    "timezone": "<string>",
    "slots": [
      {
        "day_of_week": 1,
        "start_time": "<string>",
        "end_time": "<string>"
      }
    ]
  },
  "circuit_breaker": {
    "enabled": false,
    "failure_threshold": 0.5,
    "window_seconds": 120,
    "min_calls_in_window": 5
  },
  "executed_count": 0,
  "total_queued_count": 0,
  "parent_campaign_id": 1,
  "redialed_campaign_id": 1,
  "telephony_configuration_id": 1,
  "telephony_configuration_name": "<string>",
  "logs": [
    {
      "ts": "<string>",
      "level": "<string>",
      "event": "<string>",
      "message": "<string>",
      "details": {}
    }
  ]
}

post/api/v1/campaign/create

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

namestringrequired#

Length: 1–255

workflow_idintegerrequired#

source_typestringrequired#

Pattern: ^csv$

source_idstringrequired#

telephony_configuration_idinteger · null#

Show child attributes

Any of

retry_configobject · null#

Show child attributes

Any of

enabledboolean#

Default: true

max_retriesinteger#

Default: 2

Range: 0–10

retry_delay_secondsinteger#

Default: 120

Range: 30–3600

retry_on_busyboolean#

Default: true

retry_on_no_answerboolean#

Default: true

retry_on_voicemailboolean#

Default: true

max_concurrencyinteger · null#

Show child attributes

Any of

schedule_configobject · null#

Show child attributes

Any of

enabledboolean#

Default: true

timezonestring#

Default: "UTC"

slotsobject[]required#

Items: 1–50

Show child attributes

day_of_weekintegerrequired#

Range: 0–6

start_timestringrequired#

Pattern: ^\d{2}:\d{2}$

end_timestringrequired#

Pattern: ^\d{2}:\d{2}$

circuit_breakerobject · null#

Show child attributes

Any of

enabledboolean#

Default: true

failure_thresholdnumber#

Default: 0.5

Range: 0–1

window_secondsinteger#

Default: 120

Range: 30–600

min_calls_in_windowinteger#

Default: 5

Range: 1–100

Responses

application/json

Successful Response

idintegerrequired#

namestringrequired#

workflow_idintegerrequired#

workflow_namestringrequired#

statestringrequired#

source_typestringrequired#

source_idstringrequired#

total_rowsinteger · nullrequired#

Show child attributes

Any of

processed_rowsintegerrequired#

failed_rowsintegerrequired#

created_atstringrequired#

started_atstring · nullrequired#

Show child attributes

Any of

completed_atstring · nullrequired#

Show child attributes

Any of

retry_configobjectrequired#

Show child attributes

enabledbooleanrequired#

max_retriesintegerrequired#

retry_delay_secondsintegerrequired#

retry_on_busybooleanrequired#

retry_on_no_answerbooleanrequired#

retry_on_voicemailbooleanrequired#

max_concurrencyinteger · null#

Show child attributes

Any of

schedule_configobject · null#

Show child attributes

Any of

enabledbooleanrequired#

timezonestringrequired#

slotsobject[]required#

Show child attributes

day_of_weekintegerrequired#

start_timestringrequired#

end_timestringrequired#

circuit_breakerobject · null#

Show child attributes

Any of

enabledboolean#

Default: false

failure_thresholdnumber#

Default: 0.5

window_secondsinteger#

Default: 120

min_calls_in_windowinteger#

Default: 5

executed_countinteger#

Default: 0

total_queued_countinteger#

Default: 0

parent_campaign_idinteger · null#

Show child attributes

Any of

redialed_campaign_idinteger · null#

Show child attributes

Any of

telephony_configuration_idinteger · null#

Show child attributes

Any of

telephony_configuration_namestring · null#

Show child attributes

Any of

logsobject[]#

Show child attributes

tsstringrequired#

levelstringrequired#

eventstringrequired#

messagestringrequired#

detailsobject · null#

Show child attributes

Any of

Get Daily Usage Breakdown Get Campaigns