Skip to main content
POST
stop a campaign

Authorizations

Authorization
string
header
required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Path Parameters

campaign_id
string<uuid>
required

the campaign's id.

Response

ok.

an outbound campaign, with live counts of its contacts by state.

id
string<uuid>
required
name
string
required
description
string | null
required
status
string
required
audienceId
string<uuid> | null
required
audienceName
string
required
userAgentId
string<uuid> | null
required
agentName
string | null
required
phoneLineKind
string
required
phoneLineId
string<uuid> | null
required
fromNumber
string | null
required
maxConcurrentCalls
integer
required
retryEnabled
boolean
required
retryDelayMinutes
integer
required
maxRetries
integer
required
scheduledAt
string<date-time> | null
required
startedAt
string<date-time> | null
required
completedAt
string<date-time> | null
required
cancelledAt
string<date-time> | null
required
lastError
string | null
required
notice
string | null
required
noticeAt
string<date-time> | null
required
stats
CampaignStats · object
required

How many of the campaign's contacts sit in each state.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
contextColumns
ContextColumn · object[] | null