Skip to main content
PATCH
Update auto-bidding setup

Authorizations

X-API-TOKEN
string
header
required

API token for authentication

Path Parameters

id
integer
required

Setup ID

Body

application/json

Setup fields in camelCase. A field left out keeps its value; on a new setup it takes the default. Unknown fields, id and status are ignored

name
string
enableManualTrigger
boolean

Bid only on jobs sent by hand; then filterId is optional

filterId
integer

An active filter, from GET /auto-bidding/options

templateId
integer

One proposal template. Use biddingTemplates for an A/B test

biddingTemplates
object[]

Up to 5 templates. Two or more start an A/B test

Maximum array length: 5
abAutoPromote
boolean
abWinnerMetric
enum<string>
default:reply_rate
Available options:
reply_rate,
view_rate
abStopCondition
enum<string>
default:proposals
Available options:
proposals,
time
abStopProposals
integer
Required range: 10 <= x <= 500
abStopDays
integer
Required range: 3 <= x <= 60
schedule
enum<string>
Available options:
24/7,
custom_schedule
customSchedule
object[]

At least one slot on a custom schedule

timezone
string

IANA name, for example Europe/Kyiv

enableBiddingDelay
boolean
biddingDelay
integer

Minutes

Required range: 1 <= x <= 60
enableDailyLimit
boolean
dailyProposalsLimit
integer
Required range: 1 <= x <= 50
enableBoosting
boolean
boostMode
enum<string>
Available options:
fixed,
smart
boostMaxBidAmount
integer

Fixed mode, connects

Required range: 1 <= x <= 999
boostDailyConnectsLimit
integer
Required range: 1 <= x <= 500
boostCases
object[]

Smart mode: 1 to 5 cases

Maximum array length: 5
enableAiJobQualifier
boolean
aiQualifierSource
enum<string>
Available options:
filter,
custom
aiJobQualifierPrompt
string

With source custom. Source filter runs on the filter's prompt, which changes only on the filter

aiJobQualifierModel
string
enableCatchUpBidding
boolean
maxJobAgeHours
integer | null

null is no limit

Required range: 1 <= x <= 72
enableNotifications
boolean
preScreeningTelegramChatId
string | null
enablePreScreening
boolean

Jobs wait for review before they are sent

preScreeningTimeoutMinutes
integer
Required range: 15 <= x <= 480
preScreeningTimeoutAction
enum<string>
Available options:
approve,
skip
applyIfAlreadyAppliedByAnotherBidder
boolean
notifyDisqualifiedJobs
boolean
roomInviteSettings
object | null

null uses the team-wide settings

Response

Successful operation

status
string
Example:

"saved"

setup
object

An auto-bidding setup in full, as the setup write endpoints return it. Dates are UTC

abTestRestarted
boolean

A new template set started a fresh A/B test