Skip to content
vocapable.Docs

Change how long phone data is kept (owners)

PUT
/v1/workspace/phone/retention
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/phone/retention \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "recordings_days": 1, "transcripts_days": 1, "texts_days": 1, "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PhoneRetentionUpdate
object
recordings_days
required
Recordings Days
integer
>= 1 <= 3650
transcripts_days
required
Transcripts Days
integer
>= 1 <= 3650
texts_days
required
Texts Days
integer
>= 1 <= 3650
expected_revision
required
Expected Revision
integer
>= 1
Examplegenerated
{
  "recordings_days": 1,
  "transcripts_days": 1,
  "texts_days": 1,
  "expected_revision": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PhoneRetention
object
recordings_days
required
Recordings Days
integer
transcripts_days
required
Transcripts Days
integer
texts_days
required
Texts Days
integer
bounds
required
PhoneRetentionBoundsView
object
recordings
required
RetentionRange
object
min
required
Min
integer
max
required
Max
integer
transcripts
required
RetentionRange
object
min
required
Min
integer
max
required
Max
integer
texts
required
RetentionRange
object
min
required
Min
integer
max
required
Max
integer
defaults
required
PhoneRetentionDefaults
object
recordings
required
Recordings
integer
transcripts
required
Transcripts
integer
texts
required
Texts
integer
revision
required
Revision
integer
enforcement
required
Enforcement
string
Allowed values: scheduled not_scheduled
enforcement_by_kind
required
PhoneRetentionEnforcement

What actually happens to data past its window, per kind - stated, not implied.

object
recordings
required
Recordings
string
Allowed values: applied scheduled not_scheduled
transcripts
required
Transcripts
string
Allowed values: applied scheduled not_scheduled
texts
required
Texts
string
Allowed values: applied scheduled not_scheduled
can_edit
required
Can Edit
boolean
updated_at
required
Any of:
string format: date-time
Example
{
  "enforcement": "scheduled",
  "enforcement_by_kind": {
    "recordings": "applied",
    "transcripts": "applied",
    "texts": "applied"
  }
}

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