Update the Subscribe Rules for the Participant

POST /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules
Account sid auth token

Update the Subscribe Rules for the Participant

Path parameters

  • RoomSid string Required

    The SID of the Room resource where the subscribe rules to update apply.

  • ParticipantSid string Required

    The SID of the Participant resource to update the Subscribe Rules.

application/x-www-form-urlencoded

Body

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

      The SID of the Participant resource for the Subscribe Rules.

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

    • room_sid string | null

      The SID of the Room resource for the Subscribe Rules

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

    • rules array[object(subscribe-rule)] | null

      A collection of Subscribe Rules that describe how to include or exclude matching tracks. See the Specifying Subscribe Rules section for further information.

      Hide rules attributes Show rules attributes object(subscribe-rule)
      • type string
      • all boolean
      • publisher string
      • track string
      • kind string
      • priority string
    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.
POST /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules 
curl \
 --request POST 'https://video.twilio.com/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Rules=%255B%257B%2522type%2522%253A%2522exclude%2522%252C%2522all%2522%253A%2520true%257D%255D'
Request example 
{"Rules"=>"%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D"}
Response examples (200) 
{
  "rules": [
    {
      "all": true,
      "kind": null,
      "type": "exclude",
      "track": null,
      "priority": null,
      "publisher": null
    }
  ],
  "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": null,
  "date_updated": null,
  "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}