Update task limits
Updates organization Task settings such as business hours, per-target cooldowns, and default retry behavior. Reseller administrators can also update call capacity. Set businessHours or defaultRetryConfiguration to null to disable that behavior.
OpenAPI
````yaml post /api/v2/tasks/limits
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/tasks/limits:
post:
tags:
- Tasks
summary: Update task limits
description: >-
Updates organization Task settings such as business hours, per-target
cooldowns, and default retry behavior. Reseller administrators can also
update call capacity. Set businessHours or defaultRetryConfiguration to
null to disable that behavior.
requestBody:
content:
application/json:
schema:
type: object
properties:
businessHours:
type: object
description: Timezone plus grouped availability windows.
example:
timezone: America/Chicago
windows:
- days:
- 1
- 2
- 3
- 4
start: '08:00'
end: '18:00'
- days:
- 5
start: '09:00'
end: '15:00'
- days:
- 6
start: '09:00'
end: '12:00'
cooldowns:
type: object
description: >-
Minimum seconds between Tasks for the same target and
channel
properties:
calls:
type: integer
minimum: 0
texts:
type: integer
minimum: 0
tasks:
type: integer
minimum: 0
maxConcurrentCalls:
type: integer
minimum: 1
description: Maximum simultaneous active Task calls
callsPerSecond:
type: integer
minimum: 1
description: Maximum Task call starts per second
defaultRetryConfiguration:
type: object
nullable: true
description: >-
Complete organization default applied when a call, text, or
email Task omits either its goal or retryPolicy. Defaults
use same-channel delaysSeconds; null disables the
organization default.
required:
- goal
- retryPolicy
properties:
goal:
type: object
required:
- completionCriteria
properties:
completionCriteria:
type: string
retryPolicy:
type: object
required:
- delaysSeconds
- retryOn
properties:
delaysSeconds:
type: array
minItems: 1
maxItems: 10
items:
type: integer
minimum: 60
maximum: 2592000
retryOn:
type: array
minItems: 1
items:
type: string
enum:
- busy
- delivery_failed
- goal_incomplete
- no_answer
- no_response
- no_speech
- rejected
- transient_failure
- voicemail
responseTimeoutSeconds:
type: integer
minimum: 60
maximum: 604800
responses:
'200':
description: Limits updated successfully
'400':
description: Invalid Task settings
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Internal Server Error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
