Update an existing Channel Participant

POST /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}

TODO: Resource-level docs

Update an existing Channel Participant.

Path parameters

  • InteractionSid string Required

    The Interaction Sid for this channel.

  • ChannelSid string Required

    The Channel Sid for this Participant.

  • Sid string Required

    The unique string created by Twilio to identify an Interaction Channel resource.

Body

  • Status string Required

    The Participant's status. Can be: closed or wrapup. Participant must be an agent.

    Values are close, closed, or wrapup.

Responses

  • 200

    OK

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

      The Channel Sid for this Participant.

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

    • interaction_sid string | null

      The Interaction Sid for this channel.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KD[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: ^UT[0-9a-fA-F]{32}$.

    • type string | null

      Participant type.

      Values are supervisor, customer, external, agent, or unknown.

    • url string(uri) | null
POST /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid} 
curl \
 -X POST https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=close'
Request example 
{
  "Status": "close"
}
Request examples 
{
  "Status": "close"
}
Response examples (200) 
{
  "channel_sid": "string",
  "interaction_sid": "string",
  "sid": "string",
  "type": "supervisor",
  "url": "https://example.com"
}
Response examples (200) 
{
  "channel_sid": "string",
  "interaction_sid": "string",
  "sid": "string",
  "type": "supervisor",
  "url": "https://example.com"
}