Skip to navigation
API ReferenceConferencesParticipants

Update Participant

Mute, hold, or whisper. Only the fields you send change, and only real changes are applied.

  • muted: true: nobody hears them; they still hear everyone.
  • on_hold: true: they hear hold audio; nobody hears them.
  • whisper_to: ["specialist"]: only the specialist hears them. null goes back to everyone.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
participantstringRequired

Request

This endpoint expects an object.
labelstring or nullOptionalformat: "^[A-Za-z0-9_-]{1,64}$"
mutedbooleanOptional
on_holdbooleanOptional
whisper_tolist of stringsOptional

Only these participants (call IDs or labels) can hear this one; it still hears everyone. null means everyone hears it (the default). Stored as call IDs, so relabeling someone doesn’t change who hears a whisper.

Response

Updated participant.
call_idstring

The participant is this call; every call API works on it.

conference_idstring
labelstring or null
statusenum
  • dialing: A dialed participant whose call hasn’t answered yet.
  • ringing: Answered and being connected (or hearing its announce).
  • joined: In the conference.
  • left: Hung up or was removed.
  • failed: Never connected (busy, no answer, rejected, or an error).
Allowed values:
fromstring or null
tostring or null
mutedboolean

Nobody hears this participant; they still hear everyone.

on_holdboolean
They hear hold audio and nobody hears them.
whisper_tolist of strings or null

Call IDs of the only participants who can hear this one, or null for everyone.

end_conference_on_leaveboolean
When this participant leaves, the conference ends for everyone.
joined_atstring or nullformat: "date-time"
left_atstring or nullformat: "date-time"
left_reasonenum or null

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
502
Bad Gateway Error