Skip to content
vocapable.Docs

Change your phone alerts

PATCH
/v1/mobile/workspace/me/owner-alerts
curl --request PATCH \
  --url https://api.vocapable.com/v1/mobile/workspace/me/owner-alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "missed_not_returned": true, "missed_not_returned_minutes": 1, "queue_wait": true, "queue_wait_seconds": 1, "rep_unreachable": true, "consent_refusals": true, "consent_refusals_per_hour": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
OwnerAlertSettingsUpdate
object
expected_revision
required
Expected Revision
integer
>= 1
missed_not_returned
Any of:
boolean
missed_not_returned_minutes
Any of:
integer
>= 5 <= 1440
queue_wait
Any of:
boolean
queue_wait_seconds
Any of:
integer
>= 30 <= 1800
rep_unreachable
Any of:
boolean
consent_refusals
Any of:
boolean
consent_refusals_per_hour
Any of:
integer
>= 1 <= 100
Examplegenerated
{
  "expected_revision": 1,
  "missed_not_returned": true,
  "missed_not_returned_minutes": 1,
  "queue_wait": true,
  "queue_wait_seconds": 1,
  "rep_unreachable": true,
  "consent_refusals": true,
  "consent_refusals_per_hour": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
OwnerAlertSettings
object
missed_not_returned
required
Missed Not Returned
boolean
missed_not_returned_minutes
required
Missed Not Returned Minutes
integer
queue_wait
required
Queue Wait
boolean
queue_wait_seconds
required
Queue Wait Seconds
integer
rep_unreachable
required
Rep Unreachable
boolean
consent_refusals
required
Consent Refusals
boolean
consent_refusals_per_hour
required
Consent Refusals Per Hour
integer
consent_refusals_available
required
Consent Refusals Available
boolean
revision
required
Revision
integer
Examplegenerated
{
  "missed_not_returned": true,
  "missed_not_returned_minutes": 1,
  "queue_wait": true,
  "queue_wait_seconds": 1,
  "rep_unreachable": true,
  "consent_refusals": true,
  "consent_refusals_per_hour": 1,
  "consent_refusals_available": true,
  "revision": 1
}

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": {}
    }
  ]
}