Add Event Destination

Attach a channel as a destination to an existing event

Attach an existing channel to an event as a destination. Create the event first with Create Event, and the channel with Add Channel. To detach it again, use Delete Event Destination.

curl -X POST \
     -H "Authorization: Bearer [access token]" \
     -H "Content-Type: application/json" \
     -d '{"channelId": 12345, "streamingOrientation": "horizontal"}' \
     https://api.restream.io/v2/user/events/{eventId}/destinations

curl -X POST \
     -H "Authorization: Bearer [access token]" \
     -H "Content-Type: application/json" \
     -d '{"channelId": 12345, "title": "My weekly show", "description": "Episode 12", "privacyStatus": "public", "createEventPost": true, "latencyPreference": "low"}' \
     https://api.restream.io/v2/user/events/{eventId}/destinations

Path Parameters:

Request Body

Common Fields

These fields apply to every platform.

Platform-Specific Fields

Some platforms accept extra fields alongside the common ones. Which fields are read depends on the platform of the channel passed in channelId; fields that belong to a different platform are ignored. Platforms not listed below take no platform-specific fields.

YouTube (platformId 5)

On YouTube the destination is a YouTube broadcast, so its metadata is part of the request.

Embed Player (platformId 83)

Supported Platforms

The channel's platform determines whether it can be attached.

Response

{
  "id": "8f3b1c2a-1d4e-4a9b-9c7d-2e5f6a7b8c9d"
}

{
  "error": {
    "statusCode": 400,
    "status": 400,
    "code": 400,
    "message": "This channel platform is not supported for event destinations yet",
    "name": "event_destination_platform_not_supported"
  }
}

{
  "error": {
    "statusCode": 400,
    "status": 400,
    "code": 400,
    "message": "adsFrequency: Ads frequency must be specified when monetization is enabled",
    "name": "invalid_body_params"
  }
}

{
  "error": {
    "statusCode": 400,
    "status": 400,
    "code": 400,
    "message": "EventContainsRestrictedSymbol",
    "name": "event_contains_restricted_symbol"
  }
}

{
  "error": {
    "statusCode": 409,
    "status": 409,
    "code": 409,
    "message": "EventDestinationAlreadyExists",
    "name": "event_destination_already_exists"
  }
}