Bundle Replace Items Resource
Info
This page is specifically about the Replace Items subresource of a Bundle. Please refer to Regulatory Compliance REST APIs for general knowledge or FAQ page.
With the new Replace Items resource, developers can now update their compliance information when Regulations change while continuing to provision new Phone Numbers before their compliance information is no longer valid. The Replace Items resource replaces a twilio-approved Regulatory Bundle's Items with a twilio-approved Bundle Copy. By replacing the old items with the newly approved Bundle Copy Items Assigned, you will not have to worry about reassigning any Phone Numbers or other potential dependencies that rely on the Bundle.
The field of the Bundle resource response is in JSON. The type SID<BU> is a unique ID starting with letters BU. For more information about Twilio SIDs, please refer to Twilio's glossary on SIDs.
The unique string that we created to identify the Bundle resource.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Account that created the Bundle resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The unique string of a regulation that is associated to the Bundle resource.
^RN[0-9a-fA-F]{32}$Min length: 34Max length: 34The verification status of the Bundle resource.
draftpending-reviewin-reviewtwilio-rejectedtwilio-approvedprovisionally-approvedThe date and time in GMT in ISO 8601 format when the resource will be valid until.
The email address that will receive updates when the Bundle resource changes status.
The URL we call to inform your application of status changes.
The date and time in GMT when the resource was created specified in ISO 8601 format.
The following statuses encompass the Bundle lifecycle.
| Status | Description |
|---|---|
| draft | The user has created a new Bundle that can be edited with Supporting Documents and End-User objects assigned. |
| pending-review | When the user has finished the draft of the Bundle and submits to Twilio for review, the status moves from draft to pending-review. |
| in-review | Twilio 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-rejected | Twilio has reviewed the Bundle and has determined the Bundle does not meet the regulations. |
| twilio-approved | Twilio has reviewed the Bundle and has determined the Bundles does meet the regulations. |
POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems
The unique string that identifies the Bundle where the item assignments are going to be replaced.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedThe source bundle sid to copy the item assignments from.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createReplaceItems() {11const replaceItem = await client.numbers.v2.regulatoryCompliance12.bundles("BUef3a237936fb63163fd852d77c5ba27b")13.replaceItems.create({14fromBundleSid: "BU504eddd19f1efa428458f6daed683667",15});1617console.log(replaceItem.sid);18}1920createReplaceItems();
Response
1{2"sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"friendly_name": "friendly_name",6"status": "draft",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}
Only the create operation is available for the Replace Items resource as the operation is a one-time event. To perform the even again, a new Bundle Copy will need to be created and approved before the Replace Items operation event can be triggered. There is no GET or DELETE available for this resource.