Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Bundle Replace Items Resource


(information)

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.


Replace Items Response properties

replace-items-response-properties page anchor

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.

Resource properties
sidtype: SID<BU>Not PII

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


regulation_sidtype: SID<RN>Not PII

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


friendly_nametype: stringNot PII

The string that you assigned to describe the resource.


statustype: enum<STRING>Not PII

The verification status of the Bundle resource.

Possible values:
draftpending-reviewin-reviewtwilio-rejectedtwilio-approvedprovisionally-approved

valid_untiltype: string<DATE TIME>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.


emailtype: stringNot PII

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


status_callbacktype: string<URI>Not PII

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


date_createdtype: string<DATE TIME>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_updatedtype: string<DATE TIME>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.

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.

Replace Items from Bundle Copy to original Bundle

replace-items-from-bundle-copy-to-original-bundle page anchor
POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems

Parameters

create-parameters page anchor
URI parameters
BundleSidtype: SID<BU>Not PII
Path Parameter

The unique string that identifies the Bundle where the item assignments are going to be replaced.


Request body parameters
FromBundleSidtype: SID<BU>Not PII
Required

The source bundle sid to copy the item assignments from.

Replace Items from Bundle Copy to original Bundle

replace-items-from-bundle-copy-to-original-bundle-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.numbers.v2.regulatoryCompliance
_12
.bundles('BUef3a237936fb63163fd852d77c5ba27b')
_12
.replaceItems
_12
.create({fromBundleSid: 'BU504eddd19f1efa428458f6daed683667'})
_12
.then(replace_items => console.log(replace_items.sid));

Output

_12
{
_12
"sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"regulation_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"friendly_name": "friendly_name",
_12
"status": "draft",
_12
"valid_until": "2015-07-30T20:00:00Z",
_12
"email": "email",
_12
"status_callback": "http://www.example.com",
_12
"date_created": "2015-07-30T20:00:00Z",
_12
"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.


Rate this Page: