Delete a participant

realtime_kit.meetings.delete_meeting_participant(, ) -> MeetingDeleteMeetingParticipantResponse

DELETE/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Deletes a participant for the given meeting and participant ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

account_id: str

The account identifier tag.

maxLength32

app_id: str

The app identifier tag.

maxLength32

meeting_id: str

formatuuid

participant_id: str

ReturnsExpand Collapse

class MeetingDeleteMeetingParticipantResponse: …

success: bool

Success status of the operation

data: Optional[Data]

Data returned by the operation

created_at: datetime

Timestamp this object was created at. The time is returned in ISO format.

formatdate-time

custom_participant_id: str

A unique participant ID generated by the client.

preset_id: str

ID of the preset applied to this participant.

formatuuid

updated_at: datetime

Timestamp this object was updated at. The time is returned in ISO format.

formatdate-time

Delete a participant

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.realtime_kit.meetings.delete_meeting_participant(
    participant_id="participant_id",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="app_id",
    meeting_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.success)

{
  "success": true,
  "data": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "custom_participant_id": "custom_participant_id",
    "preset_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}

Returns Examples

{
  "success": true,
  "data": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "custom_participant_id": "custom_participant_id",
    "preset_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}