Skip to content
vocapable.Docs

Upload hold music (MP3/WAV, 5 MB, 10 minutes) with a rights attestation

POST
/v1/mobile/workspace/hold-music
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/workspace/hold-music \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "content_base64": "example", "content_type": "audio/mpeg", "rights_attested": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

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

Unique key for this request. A retry after a lost response or a reconnect replays the original result instead of saving the note or task twice.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SharedPhoneHoldMusicUpload

Upload a hold track: MP3 or WAV, at most 5 MB and 10 minutes (E4-R4).

rights_attested must be true: the uploader confirms the company holds the rights to play this recording to callers (public performance), which is recorded with them.

object
name
required
Name
string
>= 1 characters <= 60 characters
content_base64
required
Content Base64
string
>= 8 characters <= 6990508 characters
content_type
Any of:
string
Allowed values: audio/mpeg audio/mp3 audio/wav audio/x-wav
rights_attested
required
Rights Attested
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
SharedPhoneHoldMusicTrack
object
id
required
Id
string
name
required
Name
string
duration_ms
required
Duration Ms
integer
size_bytes
required
Size Bytes
integer
rights_attested_at
required
Rights Attested At
string format: date-time
rights_attested_by_name
required
Any of:
string
created_at
required
Created At
string format: date-time
Examplegenerated
{
  "id": "example",
  "name": "example",
  "duration_ms": 1,
  "size_bytes": 1,
  "rights_attested_at": "2026-04-15T12:00:00Z",
  "rights_attested_by_name": "example",
  "created_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": {}
    }
  ]
}