Enroll a Contact in an objective and merge its state
Atomically ensures List membership and recursively merges the request into customFields[listName]. Explicit null removes a field. A non-object collision returns 409.
OpenAPI
````yaml patch /api/v2/contact/{contactId}/list/{listName}/state
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/contact/{contactId}/list/{listName}/state:
patch:
tags:
- Contacts
summary: Enroll a Contact in an objective and merge its state
description: >-
Atomically ensures List membership and recursively merges the request
into customFields[listName]. Explicit null removes a field. A non-object
collision returns 409.
parameters:
- name: contactId
in: path
required: true
schema:
type: string
- name: listName
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
'409':
description: The matching customFields key contains non-object data.
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
