Create invite

POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites

TODO: Resource-level docs

Path parameters

Body

  • Identity string Required
  • RoleSid string

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

Responses

  • 201

    Created

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

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

    • channel_sid string | null

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

    • created_by string | null
    • date_created string(date-time) | null
    • date_updated string(date-time) | null
    • identity string | null
    • role_sid string | null

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

    • service_sid string | null

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

    • sid string | null

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

    • url string(uri) | null
POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites 
curl \
 -X POST https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Identity=string&RoleSid=string'
Request example 
{
  "Identity": "string",
  "RoleSid": "string"
}
Request examples 
{
  "Identity": "string",
  "RoleSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "channel_sid": "string",
  "created_by": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "identity": "string",
  "role_sid": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "channel_sid": "string",
  "created_by": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "identity": "string",
  "role_sid": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}