Update account details
Update selected profile details or supported settings for an account.
OpenAPI
````yaml post /api/v2/account
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/account:
post:
tags:
- Accounts
summary: Update account details
description: Update selected profile details or supported settings for an account.
parameters:
- name: targetAccountId
in: query
description: Target account ID when acting on behalf of another account
required: false
example: 123
schema:
type: number
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Full name
example: Ada Lovelace
partnerName:
type: string
description: Partner name (for partner accounts only)
resellerName:
type: string
description: Reseller name (for reseller accounts only)
orgName:
type: string
description: Organization name
accountName:
type: string
description: Account name
firstName:
type: string
description: First name
lastName:
type: string
description: Last name
description:
type: string
description: Profile description
image:
type: string
description: Profile image URL
businessName:
type: string
description: Business name
businessAddress:
type: string
description: Business address
email:
type: string
format: email
description: Email address
settings:
type: object
description: >-
Supported account-level reporting and dashboard settings.
Existing settings outside the supplied fields are preserved;
each supplied array is a complete replacement for that
array.
properties:
reportingFields:
type: array
description: >-
Structured fields extracted from conversations for
reporting. Sending this array replaces the current
reporting-field list at this account level.
items:
type: object
required:
- key
- label
- instructions
- values
properties:
key:
type: string
pattern: ^[a-z][a-z0-9_]*$
example: appointment_booked
label:
type: string
example: Appointment booked
instructions:
type: string
example: >-
True when the customer agrees to a specific
appointment time.
values:
type: object
required:
- kind
properties:
kind:
type: string
enum:
- boolean
- choices
- number
- text
choices:
type: array
items:
type: string
description: Allowed values when kind is choices.
metrics:
type: array
description: >-
The complete replacement list for organization dashboard
metrics; this is not an append operation. Before adding
or updating a metric, read the current organization
account and submit every metric that should remain. Do
not send only the new metric. If the stored list is
missing or empty, the dashboard may still show visible
defaults; confirm the intended complete list before
creating an organization override.
items:
type: object
additionalProperties: true
defaultOrgSettings:
type: object
description: >-
Defaults inherited by newly created organizations under
a reseller.
properties:
metrics:
type: array
description: >-
Default dashboard metric definitions for new
organizations. Sending this array replaces the
current default list.
items:
type: object
additionalProperties: true
responses:
'200':
description: Updated account details
content:
application/json:
schema:
type: object
'400':
description: Bad Request
'401':
description: Unauthorized
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````