Replace a participant's detail

client.RealtimeKit.Meetings.ReplaceParticipant(ctx, appID, meetingID, participantID, params) (*MeetingReplaceParticipantResponse, error)

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

Replaces a participant’s details 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

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

appID string

The app identifier tag.

meetingID string

formatuuid

participantID string

params MeetingReplaceParticipantParams

AccountID param.Field[string]

Path param: The account identifier tag.

maxLength32

CustomParticipantID param.Field[string]

Body param: Unique participant ID accepted by the replace participant API.

PresetName param.Field[string]

Body param: Name of the preset to apply to this participant.

Name param.Field[string]Optional

Body param: (Optional) Name of the participant.

Picture param.Field[string]Optional

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

formaturi

ReturnsExpand Collapse

type MeetingReplaceParticipantResponse struct{…}

Success bool

Success status of the operation

Data MeetingReplaceParticipantResponseDataOptional

Represents a participant.

ID string

ID of the participant.

formatuuid

Token string

The participant’s auth token that can be used for joining a meeting from the client side.

CreatedAt Time

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

formatdate-time

CustomParticipantID string

A unique participant ID generated by the client.

PresetName string

Preset applied to the participant.

UpdatedAt Time

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

formatdate-time

ExpiresOn TimeOptional

Time at which the token stops being valid, in UTC. Returned when adding a participant.

formatdate-time

Name stringOptional

Name of the participant.

NotBefore TimeOptional

Time from which the token is valid, in UTC. Returned when adding a participant.

formatdate-time

Picture stringOptional

URL to a picture of the participant.

formaturi

Replace a participant's detail

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.RealtimeKit.Meetings.ReplaceParticipant(
    context.TODO(),
    "14a396e7-ca44-4937-bf1f-050a69118543",
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "participant_id",
    realtime_kit.MeetingReplaceParticipantParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      CustomParticipantID: cloudflare.F("custom_participant_id"),
      PresetName: cloudflare.F("preset_name"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Success)
}

{
  "success": true,
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "token": "token",
    "created_at": "2019-12-27T18:11:19.117Z",
    "custom_participant_id": "custom_participant_id",
    "preset_name": "preset_name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "expires_on": "2026-10-01T11:00:00Z",
    "name": "name",
    "not_before": "2026-10-01T09:00:00Z",
    "picture": "https://example.com"
  }
}

Returns Examples

{
  "success": true,
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "token": "token",
    "created_at": "2019-12-27T18:11:19.117Z",
    "custom_participant_id": "custom_participant_id",
    "preset_name": "preset_name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "expires_on": "2026-10-01T11:00:00Z",
    "name": "name",
    "not_before": "2026-10-01T09:00:00Z",
    "picture": "https://example.com"
  }
}