Skip to content
Vocapable Developers

Acknowledge an Operations Inbox task

POST
/v1/mobile/operations/tasks/{task_id}/acknowledge
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/operations/tasks/example/acknowledge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_version": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
task_id
required
Task Id
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MobileOperationTaskAcknowledgeRequest
object
expected_version
required
Expected Version
integer
>= 1
Examplegenerated
{
  "expected_version": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileOperationTask

One durable operational follow-up rendered without customer/call content.

object
id
required
Id
string
category
required
Category
string
Allowed values: handoff emergency_override voicemail booking integration receptionist_health
severity
required
Severity
string
Allowed values: critical high normal low
state
required
State
string
Allowed values: open acknowledged resolved
title
required
Title
string
>= 1 characters <= 200 characters
detail
Any of:
string
<= 500 characters
source_target
required
MobileOperationTaskSourceTarget

An opaque source reference used only for authenticated native navigation.

object
kind
required
Kind
string
Allowed values: activity handoff emergency_override inbox
resource_id
required
Resource Id
string
>= 1 characters <= 128 characters
next_action
required
Next Action
string
Allowed values: review_handoff review_activity review_override open_integration_settings contact_support
assignee
Any of:
MobileOperationTaskActor

A permitted staff label, never an account, device, email, or destination.

object
id
required
Id
string
>= 1 characters <= 128 characters
display_name
Any of:
string
<= 200 characters
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
due_at
Any of:
string format: date-time
acknowledged_by
Any of:
MobileOperationTaskActor

A permitted staff label, never an account, device, email, or destination.

object
id
required
Id
string
>= 1 characters <= 128 characters
display_name
Any of:
string
<= 200 characters
acknowledged_at
Any of:
string format: date-time
resolved_by
Any of:
MobileOperationTaskActor

A permitted staff label, never an account, device, email, or destination.

object
id
required
Id
string
>= 1 characters <= 128 characters
display_name
Any of:
string
<= 200 characters
resolved_at
Any of:
string format: date-time
version
required
Version
integer
>= 1
Example
{
  "category": "handoff",
  "severity": "critical",
  "state": "open",
  "source_target": {
    "kind": "activity"
  },
  "next_action": "review_handoff"
}

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