Update Campaign

patch

https://api.regal.ai/v1/campaigns/{id}

API Details

Changes only the fields sent in the body. voicemail, greeting and abandonedCall are replaced as a whole, so send them complete. The channel cannot be changed.

Rate Limit

Limit Type	Value
Requests per second	10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Path Params

string

required

Unique identifier (UUID) of the campaign.

Body Params

Request body for partially updating a campaign. Omitted fields are left unchanged.

name

string

length ≥ 1

Display name of the campaign.

description

string

Optional description of the campaign's purpose.

state

string

enum

Whether the campaign is ready to run or still a draft.

Allowed:

type

string

enum

How tasks for this campaign are created and worked.

Allowed:

bypassOptIn

boolean

Whether this campaign is allowed to contact recipients who have not opted in.

conversionEventName

string | null

Name of the event that marks a contact reached by this campaign as converted.

fromNumber

string

Either the literal "dynamic" sentinel, an E.164 phone number, or an SMS short code (3 to 7 digits).

nickname

string

length ≥ 1

Internal nickname for this campaign.

goal

string

length ≥ 1

Goal of this campaign, shown to agents.

eligibleOffer

string

Offer contacts are eligible for on this campaign.

scriptUrl

uri

URL of the call script for agents to follow.

dialingMode

string

enum

Dialing mode for this campaign: preview or power dial, progressive, or predictive. Progressive/predictive may be gated by brand feature flags -- enforced at request time, not by this schema.

Allowed:

priority

integer

≤ 2000000000

Global priority for tasks in this campaign; higher numbers are handled first.

priorityStrategy

string

enum

Whether task priority stays static or decreases with each follow-up call attempt (dynamic). May be gated by a brand feature flag -- enforced at request time.

Allowed:

voicemail

object

Voicemail handling for this phone-call campaign.

greeting

object

Required for progressive/predictive dialing campaigns -- enforced at request time.

abandonedCall

object

Required for progressive/predictive dialing campaigns -- enforced at request time.

targetQueueId

uuid

Id of the queue tasks are routed to, as returned by the queue list. Required for progressive/predictive dialing campaigns -- enforced at request time.

maxParallelCalls

number

Calls placed per available agent for progressive dialing. Gated by a brand feature flag and only applicable when dialingMode is "progressive" -- enforced at request time.

predictiveCallAgentRatioCeiling

number

Max calls placed per available agent for predictive dialing, once abandon rate is within target. Only applicable when dialingMode is "predictive" -- enforced at request time.

targetAbandonRate

number

0.1 to 10

Target abandon rate (%) for predictive dialing; the calls/agent ratio auto-adjusts to stay under it. Required when dialingMode is "predictive" -- enforced at request time.

overrideFromNumber

string

Alternate outbound caller ID number. Requires the outboundani brand integration to be connected -- enforced at request time.

transferQueueId

^five9:\w+$

Id of the queue to transfer to, as returned by the queue list, or the id of a Five9 queue (five9:).

transferRateCeiling

number

0.01 to 100

Expected percentage of calls that transfer to the transfer queue. Required when a transfer queue is set -- enforced at request time.

content

string

length ≥ 1

Message content sent to contacts (or task description, for agent tasks).

mediaUrl

string

MMS media attachment sent with this campaign's message. Either a plain URL or a Handlebars template (e.g. a URL with merge tags).

channel

string

enum

Channel this campaign sends on. Immutable.

Allowed:

Responses

200The updated campaign

400Invalid id or body, a channel change, a queue or recording that is not the brand's, or a field that needs a feature the brand does not have.

403

404The brand has no campaign with that id.

429Exceeded rate limit.