Meetings

Add a participant

Changed on

Adds a participant to the given meeting ID.

post/meetings/{meeting_id}/participants

Request

  • Base URL
    https://api.dyte.io/v2
  • Auth
    HTTP basic

Path parameters

meeting_idstring uuid required

ID of the meeting. Fetch the meeting ID using the create a meeting API.

Request body

namestring nullable

(Optional) Name of the participant.

picturestring uri nullable

(Optional) A URL to a picture to be used for the participant.

preset_namestring required

Name of the preset to apply to this participant.

custom_participant_idstring required

A unique participant ID. You must specify a unique ID for the participant, for example, UUID, email address, and so on.

Example request

{
  "name": "Mary Sue",
  "picture": "https://i.imgur.com/test.jpg"
}

Response

Success response

successboolean required

Success status of the operation

Changes

    • info

      the request property default value group_call_host was added

    • breaking

      added the new path request parameter meeting_id

    • info

      the endpoint scheme security Authorization was added to the API

    • info

      the request property default value group_call_host was removed