OUoutcallerai
public

Create usecase

Changed on

Create an outbound usecase in the authenticated workspace.

post/api/v1/public/usecases

Request

  • Base URL
    https://api.outcallerai.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.outcallerai.com/api/v1/public/usecases
  • Auth
    none declared

Request body

namestring required
selectedKnowledgeBaseIdstring nullable
descriptionstring nullable
industrystring nullable
promptstring nullable
useCaseGoalsstring nullable
conclusionstring nullable
type'OUTBOUND' | 'INBOUND' | 'ONE_WAY'
agentIdstring nullable
escalationEnabledboolean
maxAttemptsinteger nullable
escalationWindowDaysinteger nullable
callsPerWeekinteger nullable
escalationUseCaseIdstring nullable
phoneNumberstring nullable
inboundNumberstring nullable
enableManagerTransferboolean
scheduleEnabledboolean
callbackTasksEnabledboolean
scheduledCallRetryDelayHoursinteger
scheduledCallMaxRetryAttemptsinteger
startTimestring
endTimestring
integrationsstring[]
taskTypesstring[]
concurrencyinteger
defaultTtsLanguagestring
defaultTtsVoicestring
defaultTtsPacenumber
defaultTtsPitchnumber
promptAiSessionIdstring nullable
tasksSchedulerConfigobject nullable

Response

Successful Response

UseCaseEnvelopeResponse required

Changes