Skip to contentSkip to navigationSkip to topbar
Twilio Docs
On this page

Bundle Clones Resource

With the Bundle Clone resource, developers can reuse compliance information across Twilio accounts. The resource creates a copy of a twilio-approved regulatory bundle against another account within the same organization. The new regulatory bundle is automatically set to the twilio-approved status, enabling you to start provisioning phone numbers in the new account immediately.

Clone Properties

clone-properties page anchor
Property nameTypeRequiredDescriptionChild properties
bundle_sidSID<BU>Optional
Not PII

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

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34
account_sidSID<AC>Optional
Not PII

The SID of the Account that created the Bundle resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
regulation_sidSID<RN>Optional
Not PII

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

Pattern: ^RN[0-9a-fA-F]{32}$Min length: 34Max length: 34
friendly_namestringOptional
Not PII

The string that you assigned to describe the resource.

statusenum<string>Optional
Not PII

The verification status of the Bundle resource.

Possible values:
draftpending-reviewin-reviewtwilio-rejectedtwilio-approvedprovisionally-approved
valid_untilstring<date-time>Optional
Not PII

The date and time in GMT in ISO 8601(link takes you to an external page) format when the resource will be valid until.

emailstringOptional
Not PII

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

status_callbackstring<uri>Optional
Not PII

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

date_createdstring<date-time>Optional
Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.

date_updatedstring<date-time>Optional
Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.

urlstring<uri>Optional
Not PII

The URL of this resource.

Creates a new clone of the Bundle in target Account. It will internally create clones of all the bundle items (identities and documents) of the original bundle

creates-a-new-clone-of-the-bundle-in-target-account-it-will-internally-create-clones-of-all-the-bundle-items-identities-and-documents-of-the-original-bundle page anchor
POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Clones

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
BundleSidSID<BU>required
Not PII

The unique string that identifies the Bundle to be cloned.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

request-body-parameters page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
TargetAccountSidSID<AC>required
Not PII

The SID of the Account where the bundle needs to be cloned.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
MoveToDraftbooleanOptional
Not PII

If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved

FriendlyNamestringOptional
Not PII

The string that you assigned to describe the cloned bundle.

Below is an example of creating a new Bundle Clone resource. The response from Twilio contains a JSON body with the created Bundle Clone's properties.

Create new Bundle CloneLink to code sample: Create new Bundle Clone
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createBundleClone() {

11
  const bundleClone = await client.numbers.v2

12
    .bundleClone("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .create({ targetAccountSid: "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" });

14


15
  console.log(bundleClone.bundleSid);

16
}

17


18
createBundleClone();

Output

1
{

2
  "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",

4
  "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "friendly_name": "friendly_name",

6
  "status": "twilio-approved",

7
  "valid_until": "2015-07-30T20:00:00Z",

8
  "email": "email",

9
  "status_callback": "http://www.example.com",

10
  "date_created": "2015-07-30T20:00:00Z",

11
  "date_updated": "2015-07-30T20:00:00Z",

12
  "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Clones"

13
}

Bundle Statuses

bundle-statuses page anchor

The following statuses encompass the Bundle lifecycle.

StatusDescription
draftThe user has created a new Bundle that can be edited with Supporting Documents and End-User objects assigned.
pending-reviewWhen the user has finished the draft of the Bundle and submits to Twilio for review, the status moves from draft to pending-review.
in-reviewTwilio has moved the Bundle from pending-review to in-review. Once Twilio has finished review, the Bundle will go either to twilio-approved or twilio-rejected.
twilio-rejectedTwilio has reviewed the Bundle and has determined the Bundle does not meet the regulations.
twilio-approvedTwilio has reviewed the Bundle and has determined the Bundles does meet the regulations.