Create a live event

Creates a live event instantly.

HTTP request

POST https://api-{application_id}.calls.sendbird.com/v1/live-events

Parameters

The following table lists the parameters that this action supports.

Parameters

Required	Type	Description
host_type	string	The type of a host. An acceptable value is `single_host`.
user_ids_for_host	array of strings	An array of IDs of the users who can be host for the live event. This property can have up to 10 user IDs.

Optional	Type	Description
title	string	Specifies the title of a live event. The length is limited to 191 characters.
cover_url	string	Specifies the URL of the cover image for the live event. The length is limited to 2,048 characters.
cover_file	file	Specifies the file of the cover image for the live event.

Response

If successful, this action returns a newly created live event in the response body.

Status: 200 OK

{
    "live_event": {
        "live_event_id": "6eec7ed4-c0ed-4480-843f-6497be86b8c6",
        "host_type": "single_host",
        "state": "created",
        "created_at": 1657689300179,
        "set_ready_at": none,
        "started_at": none,
        "ended_at": none,
        "is_host_streaming": false,
        "host": none,
        "created_by": "testuser-666e8b1",
        "set_ready_by": "",
        "started_by": "",
        "ended_by": "",
        "duration": 0,
        "participant_count": 0,
        "peak_participant_count": 0,
        "cumulative_participant_count": 0,
        "user_ids_for_host": ["testuser-666e8b1"],
        "title": "Happy Hour!",
        "cover_url": "https://happy-hour.we.com/welcome.png",
        "custom_items": {},
    }
}

List of response properties

Property name	Type	Description
live_event	nested object	The live event that has been created.

On this page

HTTP request Parameters

Response