> 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 primary event

PUT https://device.example.com:443/cluster1/vos-api/playoutcontrol/v1/events/{channelId}/primary/{primaryId}
Content-Type: application/json

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/update-primary-event

## Authentication

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

## Request

### Path parameters

- `channelId` (string, required) — ID of the channel
- `primaryId` (string, required) — ID of the primary event

### Body (application/json)

This endpoint expects a com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.UpdatePrimaryProperties.

- `asRunExtraStatus` (string, optional) — Additional information about the As-Run status for past events
- `asRunStatus` (enum, optional) — As-Run status for past events
  - Allowed values: `AIRED_OK`, `MISSING_MEDIA`, `TECHNICAL_DIFFICULTY_INVALID_ASSET`, `TECHNICAL_DIFFICULTY_UNEXPECTED_ERROR`, `TECHNICAL_DIFFICULTY_PLAY_RESTARTED`, `TECHNICAL_DIFFICULTY_SYNC_LOSS`, `TECHNICAL_DIFFICULTY_INPUT_SWITCH`, `DID_NOT_AIR_SERVICE_STOPPED`, `DID_NOT_AIR_UNEXPECTED`, `DID_NOT_AIR_EVENT_SKIPPED`, `DID_NOT_AIR_EVENT_DELETED_BY_OPERATOR`, `DID_NOT_AIR_CHANNEL_OVERRIDE`, `DID_NOT_AIR_TIMING_ERROR`, `DID_NOT_AIR_SOM_TC_NOT_IN_ASSET`, `DURATION_DISCREPANCY_ASSET_TOO_SHORT`, `PREEMPTED_BY_NEXT_EVENT`, `PREEMPTED_BY_CHANNEL_OVERRIDE`, `TECHNICAL_DIFFICULTY_LATE_START`, `JOINED_IN_PROGRESS_CHANNEL_OVERRIDE`, `CLEAN_LAYER`, `REDUNDANCY_SWITCH`
- `assetId` (string, optional) — Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets
- `assetTitle` (string, optional) — Text or additional information about the asset, usually the material title
- `audioProfileName` (string, optional) — The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets
- `description` (string, optional) — Descriptive text that may contain additional information about the event
- `duration` (string, optional) — Length of the event (hh:mm:ss.sss)
- `endMode` (enum, optional) — Specifies how the event will end (Duration or Manual)
  - Allowed values: `DURATION`, `MANUAL`
- `materialType` (string, optional) — Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation
- `scte35WindowEnd` (string, optional) — End time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. This event and following events in the same ad pod (material type is COMMERCIAL or AVAIL, and start mode is FOLLOW) are skipped if we don't receive SCTE-35 trigger with splice-time before this time, or if we don't receive SCTE-35 trigger x seconds before this time (x is 2 seconds if the event after the ad-pod is a prepared live source, otherwise it can be up to 32 seconds). Used only when the startMode is EXTERNAL
- `scte35WindowStart` (string, optional) — Start time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. Any SCTE-35 trigger with a splice-time before this time is ignored. Used only when the startMode is EXTERNAL
- `som` (string, optional) — Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset
- `somType` (enum, optional) — The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset
  - Allowed values: `RELATIVE`, `ABSOLUTE`
- `startMode` (enum, optional) — Specifies how the event will start (Fixed Time, Follow, Manual Take, or External SCTE-35 trigger)
  - Allowed values: `FIXED`, `FOLLOW`, `MANUAL`, `EXTERNAL`
- `startTime` (string, optional) — Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sssZ). The start time will be automatically calculated for all events except those with Fixed start mode
- `startTrigger` (string, optional) — Start trigger name
- `tcDuration` (string, optional) — Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)
- `tcErrorDuration` (string, optional) — Equivalent to errorDuration, but in timecode format (hh:mm:ss[:;]ff)
- `tcScte35WindowEnd` (string, optional) — Equivalent to scte35WindowEnd, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)
- `tcScte35WindowStart` (string, optional) — Equivalent to scte35WindowStart, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)
- `tcSom` (string, optional) — Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)
- `tcStartTime` (string, optional) — Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)
- `upid` (string, optional) — The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"
- `upidType` (integer, optional) — The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

## Response

### 200

Event 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

Event not found

- `any`

## Examples

### Example 1

**Request**

```json
{}
```

**Response**

```json
"string"
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/primary/primaryId"

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/events/channelId/primary/primaryId';
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/events/channelId/primary/primaryId"

	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/events/channelId/primary/primaryId")

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/events/channelId/primary/primaryId")
  .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/events/channelId/primary/primaryId', [
  '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/events/channelId/primary/primaryId");
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/events/channelId/primary/primaryId")! 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/events/channelId/primary/primaryId"

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/events/channelId/primary/primaryId';
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/events/channelId/primary/primaryId"

	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/events/channelId/primary/primaryId")

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/events/channelId/primary/primaryId")
  .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/events/channelId/primary/primaryId', [
  '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/events/channelId/primary/primaryId");
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/events/channelId/primary/primaryId")! 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()
```