v9
latestOpenAPI 3.1.02026-08-08572384577.1 KBadmin-usecases
Create Usecase
post/api/admin/usecases
Request body
workspace_idstring required
namestring required
type'OUTBOUND' | 'INBOUND' | 'ONE_WAY'
industrystring nullable
phone_numberstring nullable
promptstring nullable
use_case_goalsstring nullable
conclusionstring nullable
max_attemptsinteger nullable
escalation_window_daysinteger nullable
calls_per_weekinteger nullable
escalation_enabledboolean
enable_manager_transferboolean
schedule_enabledboolean
start_timestring
end_timestring
scheduled_call_retry_delay_hoursinteger
scheduled_call_max_retry_attemptsinteger
concurrencyinteger
integrationsstring[]
task_typesstring[]
escalation_use_case_idstring nullable
Response
Successful Response
idstring required
namestring required
workspace_idstring required
workspace_namestring required
type'OUTBOUND' | 'INBOUND' | 'ONE_WAY' required
status'active' | 'paused' | 'draft' | 'archived' required
industrystring nullable
phone_numberstring nullable
descriptionstring nullable
promptstring nullable
use_case_goalsstring nullable
conclusionstring nullable
max_attemptsinteger nullable
escalation_window_daysinteger nullable
escalation_use_case_idstring nullable
calls_per_weekinteger nullable
concurrencyinteger
escalation_enabledboolean
enable_manager_transferboolean
schedule_enabledboolean
start_timestring
end_timestring
scheduled_call_retry_delay_hoursinteger
scheduled_call_max_retry_attemptsinteger
integrationsstring[]
task_typesstring[]
leads_countinteger
active_callsinteger
created_atstring date-time required
updated_atstring date-time required