Skip to main content
POST
Create Music on Hold

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
integer
required

Tenant ID (0 for system/global)

Required range: 0 <= x <= 9007199254740991
name
string
required

Music on hold name

isLinear
boolean
required

Play tracks in linear order

routingDestinations
object[]
required

Ordered MEDIAFILE destinations that make up the playlist

defaultTenant
boolean
default:false

Set as the tenant's default music on hold

Response

200 - application/json

Created music on hold

id
number
required

Music on hold ID

tenantId
number
required

Tenant ID (0 = system)

name
string
required

Music on hold name

isLinear
boolean
required

Tracks play in linear order

defaultTenant
boolean
required

Is the tenant's default music on hold

routingDestinations
object[]
required

Ordered MEDIAFILE destinations