Menu

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 of Programmable Chat represents the all pending invitations to Users within the Service instance to become a Member of the Channel.

Properties

Each invite has these properties:

Names in PHP format
sid
sid<IN> Not PII

A 34 character string that uniquely identifies this resource.

accountSid
sid<AC> Not PII

The unique id of the Account responsible for this member.

channelSid
sid<CH> Not PII

The unique id of the Channel for this member.

serviceSid
sid<IS> Not PII

The unique id of the Service this member belongs to.

identity

A unique string identifier for this User in this Service. See the access tokens docs for more details.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated.

roleSid
sid<RL> Not PII

The Role assigned to this member.

createdBy
string Not PII

url
url Not PII

An absolute URL for this member.

List All Invites of a Channel

GET /Services/{Service SID}/Channels/{Channel SID}/Invites
Names in PHP format
identity
Optional
get string[] PII MTL: 120 DAYS

A unique string identifier for this User in this Service. See the access tokens docs for more details.

        
        
        
        

        Create an Invite to a Channel

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

        Parameters

        Names in PHP format
        identity
        Required
        post string PII MTL: 120 DAYS

        A unique string identifier for this User in this Service. See the access tokens docs for more details.

        roleSid
        Optional
        post sid<RL> Not PII

        The Role assigned to this 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}
                    
                          
                          
                          
                          

                          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.