Update background track - Docs and guides

PUT

background_tracks

{id}

Update background track

curl --request PUT \
  --url https://api.beyondwords.io/v1/background_tracks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "project": {
    "id": 1
  },
  "name": "Test track 1",
  "media": {
    "url": "https://example.com/transcoded.mp3"
  }
}
'

{
  "id": 1,
  "name": "Test track 1",
  "volume": 100,
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:05 UTC"
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

string

required

The numeric ID of your background track

Body

application/json

name

string

volume

integer

project

object

Show child attributes

media

object

Show child attributes

Response

200 - application/json

successful

integer

Unique identifier for the object

name

string

The background track name

volume

integer

Percent volume of the track

project

object

Show child attributes

media

object

Show child attributes

created

string

Time at which the object was created (ISO 8601)

updated

string

Time at which the object was updated (ISO 8601)

Delete background trackDeletes a background track from your organization.

Update background track

curl --request PUT \
  --url https://api.beyondwords.io/v1/background_tracks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "project": {
    "id": 1
  },
  "name": "Test track 1",
  "media": {
    "url": "https://example.com/transcoded.mp3"
  }
}
'

{
  "id": 1,
  "name": "Test track 1",
  "volume": 100,
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:05 UTC"
}