Update room participant

POST /v1/Rooms/{RoomSid}/Participants/{Sid}

Participants in video rooms

Path parameters

  • RoomSid string Required

    The SID of the room with the participant to update.

  • Sid string Required

    The SID of the RoomParticipant resource to update.

Body

  • Status string

    The new status of the resource. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

    Values are connected or disconnected.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • duration integer | null

      Duration of time in seconds the participant was connected

    • end_time string(date-time) | null

      The time when the participant disconnected from the room in ISO 8601 format

    • identity string | null

      The string that identifies the resource's User

    • links object(uri-map) | null

      The URLs of related resources

    • room_sid string | null

      The SID of the participant's room

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RM[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PA[0-9a-fA-F]{32}$.

    • start_time string(date-time) | null

      The time of participant connected to the room in ISO 8601 format

    • status string | null

      The status of the Participant

      Values are connected or disconnected.

    • url string(uri) | null

      The absolute URL of the resource
POST /v1/Rooms/{RoomSid}/Participants/{Sid} 
curl \
 -X POST https://video.twilio.com/v1/Rooms/{RoomSid}/Participants/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=connected'
Request example 
{
  "Status": "connected"
}
Request examples 
{
  "Status": "connected"
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "duration": 42,
  "end_time": "2023-05-04T09:42:00+00:00",
  "identity": "string",
  "links": {},
  "room_sid": "string",
  "sid": "string",
  "start_time": "2023-05-04T09:42:00+00:00",
  "status": "connected",
  "url": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "duration": 42,
  "end_time": "2024-05-04T09:42:00+00:00",
  "identity": "string",
  "links": {},
  "room_sid": "string",
  "sid": "string",
  "start_time": "2024-05-04T09:42:00+00:00",
  "status": "connected",
  "url": "https://example.com"
}