Update Conference Participant Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-call-scripting-update-conference-participant-request-schema.json",
  "title": "Update Conference Participant Request",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-texml-rest-commands-api-openapi.yml#/components/schemas/call-scripting_UpdateConferenceParticipantRequest",
  "properties": {
    "AnnounceMethod": {
      "description": "The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "AnnounceUrl": {
      "description": "The URL to call to announce something to the participant. The URL may return an MP3 fileo a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.",
      "type": "string"
    },
    "BeepOnExit": {
      "description": "Whether to play a notification beep to the conference when the participant exits.",
      "type": "boolean"
    },
    "CallSidToCoach": {
      "description": "The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.",
      "type": "string"
    },
    "Coaching": {
      "description": "Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given.",
      "type": "boolean"
    },
    "EndConferenceOnExit": {
      "description": "Whether to end the conference when the participant leaves.",
      "type": "boolean"
    },
    "Hold": {
      "description": "Whether the participant should be on hold.",
      "type": "boolean"
    },
    "HoldMethod": {
      "description": "The HTTP method to use when calling the `HoldUrl`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "HoldUrl": {
      "description": "The URL to be called using the `HoldMethod` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.",
      "type": "string"
    },
    "Muted": {
      "description": "Whether the participant should be muted.",
      "type": "boolean"
    },
    "WaitUrl": {
      "description": "The URL to call for an audio file to play while the participant is waiting for the conference to start.",
      "type": "string"
    }
  },
  "type": "object"
}