Create a new Bundle

POST /v2/RegulatoryCompliance/Bundles

TODO: Resource-level docs

Create a new Bundle.

Body

  • Email string Required

    The email address that will receive updates when the Bundle resource changes status.

  • EndUserType string

    The type of End User of the Bundle resource.

    Values are individual or business.

  • FriendlyName string Required

    The string that you assigned to describe the resource.

  • IsoCountry string

    The ISO country code of the Bundle's phone number country ownership request.

  • NumberType string

    The type of phone number of the Bundle's ownership request. Can be local, mobile, national, or toll free.

  • RegulationSid string

    The unique string of a regulation that is associated to the Bundle resource.

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

  • StatusCallback string(uri)

    The URL we call to inform your application of status changes.

Responses

  • 201

    Created

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

      The SID of the Account that created the resource

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

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • email string | null

      The email address

    • friendly_name string | null

      The string that you assigned to describe the resource

    • links object(uri-map) | null

      The URLs of the Assigned Items of the Bundle resource

    • regulation_sid string | null

      The unique string of a regulation.

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

    • status string | null

      The verification status of the Bundle resource

      Values are draft, pending-review, in-review, twilio-rejected, twilio-approved, or provisionally-approved.

    • status_callback string(uri) | null

      The URL we call to inform your application of status changes.

    • url string(uri) | null

      The absolute URL of the Bundle resource

    • valid_until string(date-time) | null

      The ISO 8601 date and time in GMT when the resource will be valid until.
POST /v2/RegulatoryCompliance/Bundles 
curl \
 -X POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Email=string&EndUserType=individual&FriendlyName=string&IsoCountry=string&NumberType=string&RegulationSid=string&StatusCallback=https%3A%2F%2Fexample.com'
Request example 
{
  "Email": "string",
  "EndUserType": "individual",
  "FriendlyName": "string",
  "IsoCountry": "string",
  "NumberType": "string",
  "RegulationSid": "string",
  "StatusCallback": "https://example.com"
}
Request examples 
{
  "Email": "string",
  "EndUserType": "individual",
  "FriendlyName": "string",
  "IsoCountry": "string",
  "NumberType": "string",
  "RegulationSid": "string",
  "StatusCallback": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "email": "string",
  "friendly_name": "string",
  "links": {},
  "regulation_sid": "string",
  "sid": "string",
  "status": "draft",
  "status_callback": "https://example.com",
  "url": "https://example.com",
  "valid_until": "2023-05-04T09:42:00+00:00"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "email": "string",
  "friendly_name": "string",
  "links": {},
  "regulation_sid": "string",
  "sid": "string",
  "status": "draft",
  "status_callback": "https://example.com",
  "url": "https://example.com",
  "valid_until": "2024-05-04T09:42:00+00:00"
}