Skip to content
vocapable.Docs

Turn spam screening or Lookup on or off

PATCH
/v1/workspace/phone-screening/settings
curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/phone-screening/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "screening_enabled": true, "lookup_enabled": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InboundScreeningSettingsUpdate
object
expected_revision
required
Expected Revision
integer
>= 1
screening_enabled
Any of:
boolean
lookup_enabled
Any of:
boolean
Examplegenerated
{
  "expected_revision": 1,
  "screening_enabled": true,
  "lookup_enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InboundScreeningSettings
object
screening_enabled
required
Screening Enabled
boolean
lookup_enabled
required
Lookup Enabled
boolean
revision
required
Revision
integer
updated_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
updated_at
required
Any of:
string format: date-time
Examplegenerated
{
  "screening_enabled": true,
  "lookup_enabled": true,
  "revision": 1,
  "updated_by": {
    "user_id": "example",
    "name": "example"
  },
  "updated_at": "2026-04-15T12:00:00Z"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}