> This page is for Harmonic.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Update a playlist trigger

PUT https://device.example.com:443/cluster1/vos-api/playoutcontrol/v1/trigger/{triggerId}
Content-Type: application/json

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/update-playlist-trigger

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `triggerId` (string, required) — Trigger ID

### Body (application/json)

This endpoint expects a com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf.

- `id` (string, optional) — Trigger id for this trigger configuration
- `matchAny` (list of com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_TriggerProperties, optional) — List of trigger properties for this trigger configuration
- `name` (string, optional) — Trigger name for this trigger configuration

## Response

### 200

Trigger has been updated

- `string`

### 201

Created

## Errors

### 400 Bad Request Error

Invalid Request

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

TriggerId not found

- `any`

### 500 Internal Server Error

Internal Error

- `any`

## Types

### com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_TriggerProperties

- `gpiProperties` (com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_GpiProperties, optional)
- `scte35Properties` (com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_Scte35Properties, optional)

### com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_GpiProperties

- `edge` (enum, optional) — GPI Edge type, rising or falling, configured in GPI application
  - Allowed values: `GPI_RISING`, `GPI_FALLING`
- `name` (string, optional) — GPI Name, configured in GPI application
- `offset` (integer, optional) — GPI extra offset in milliseconds (range 0...20000) to trigger the event start

### com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_Scte35Properties

- `matchSignal` (com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_Scte35Match, optional)
- `source` (com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_Scte35Source, optional)

### com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_Scte35Match

- `asserts` (list of string, optional) — List of asserts used to match this messages, in XPath format
- `match` (enum, optional) — Determines how the match the asserts for this trigger (ALL, ANY, NONE)
  - Allowed values: `ALL`, `ANY`, `NONE`

### com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf_Scte35Source

- `name` (string, optional) — Name of the live source that Scte35 message was received from
- `onAirSource` (boolean, optional) — Set true if the source that then Scte35 message was received from is currently on-air

## Examples

### Example 1

**Request**

```json
{}
```

**Response**

```json
"string"
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{}
```

**Response**

```json
"string"
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/trigger/triggerId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```