Get Campaign Defaults

GET /api/v1/organizations/campaign-defaults — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/organizations/campaign-defaults

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/organizations/campaign-defaults \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "concurrent_call_limit": 1,
  "from_numbers_count": 1,
  "default_retry_config": {
    "enabled": true,
    "max_retries": 1,
    "retry_delay_seconds": 1,
    "retry_on_busy": true,
    "retry_on_no_answer": true,
    "retry_on_voicemail": true
  },
  "last_campaign_settings": {
    "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
    }
  }
}

get/api/v1/organizations/campaign-defaults

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#

Responses

application/json

Successful Response

concurrent_call_limitintegerrequired#

from_numbers_countintegerrequired#

default_retry_configobjectrequired#

Show child attributes

enabledbooleanrequired#

max_retriesintegerrequired#

retry_delay_secondsintegerrequired#

retry_on_busybooleanrequired#

retry_on_no_answerbooleanrequired#

retry_on_voicemailbooleanrequired#

last_campaign_settingsobject · null#

Show child attributes

Any of

retry_configobject · null#

Show child attributes

max_concurrencyinteger · null#

Show child attributes

Any of

schedule_configobject · null#

Show child attributes

circuit_breakerobject · null#

Show child attributes

Delete Langfuse Credentials