Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Invites Resource

The Invite resource for Programmable Chat represents all pending invitations to make Users (within the Service instance) into Channel Members.

Properties

Each invite has these properties:

Names in PHP format
sid
sid<IN> Not PII

The unique string that we created to identify the Invite resource.

accountSid
sid<AC> Not PII

The SID of the Account that created the Invite resource.

channelSid
sid<CH> Not PII

The SID of the Channel the Invite resource belongs to.

serviceSid
sid<IS> Not PII

The SID of the Service the Invite resource is associated with.

identity

The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
date_time<iso8601> Not PII

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

roleSid
sid<RL> Not PII

The SID of the Role assigned to the resource.

createdBy
string Not PII

The identity of the User that created the invite.

url
url Not PII

The absolute URL of the Invite resource.

List All Invites of a Channel

GET /Services/{Service SID}/Channels/{Channel SID}/Invites
Names in PHP format
serviceSid
Required
get sid<IS> Not PII

The SID of the Service to read the Invite resources from.

channelSid
Required
get sid_like<CH> Not PII

The SID of the Channel the Invite resources to read belong to. This value can be the Channel resource's sid or unique_name.

identity
Optional
get string[] PII MTL: 120 DAYS

The User's identity value of the resources to read. See access tokens for more details.

        
        
        
        

        Create an Invite to a Channel

        POST /Services/{Service SID}/Channels/{Channel SID}/Invites
        

        Parameters

        Names in PHP format
        serviceSid
        Required
        post sid<IS> Not PII

        The SID of the Service to create the Invite resource under.

        channelSid
        Required
        post sid_like<CH> Not PII

        The SID of the Channel the new Invite resource belongs to. This value can be the Channel resource's sid or unique_name.

        identity
        Required
        post string PII MTL: 120 DAYS

        The identity value that uniquely identifies the new resource's User within the Service. See access tokens for more info.

        roleSid
        Optional
        post sid<RL> Not PII

        The SID of the Role assigned to the new member.

              
              
              
              

              Read an Invite to a Channel

              GET /Services/{Service SID}/Channels/{Channel SID}/Invites/{Invite SID}
              
                    
                    
                    
                    

                    Delete an Invite from a Channel

                    DELETE /Services/{Service SID}/Channels/{Channel SID}/Invites/{Invite SID}
                    
                          
                          
                          
                          
                          Rate this page:

                          Need some help?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.