Create Regulatory Bundle - Kallabot Documentation

POST

/

regulatory

/

bundles

Create Regulatory Bundle

curl --request POST \
  --url https://api.kallabot.com/regulatory/bundles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "friendly_name": "Business Phone Number Bundle",
  "email": "[email protected]",
  "iso_country": "US",
  "end_user_type": "business",
  "number_type": "local"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    friendly_name: 'Business Phone Number Bundle',
    email: '[email protected]',
    iso_country: 'US',
    end_user_type: 'business',
    number_type: 'local'
  })
};

fetch('https://api.kallabot.com/regulatory/bundles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kallabot.com/regulatory/bundles"

payload = {
    "friendly_name": "Business Phone Number Bundle",
    "email": "[email protected]",
    "iso_country": "US",
    "end_user_type": "business",
    "number_type": "local"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "sid": "<string>",
  "friendly_name": "<string>",
  "status": "draft",
  "regulation_sid": "<string>",
  "account_sid": "<string>",
  "email": "<string>",
  "date_created": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "request_parameters": {
    "iso_country": "<string>",
    "end_user_type": "<string>",
    "number_type": "<string>",
    "regulation_sid": "<string>"
  },
  "note": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

friendly_name

string

required

Bundle display name

Example:

"Business Phone Number Bundle"

email

string<email>

required

Email for status updates

Example:

"[email protected]"

regulation_sid

string

Specific regulation SID (optional)

Example:

"RG12345"

iso_country

string

Country code (if not using regulation_sid)

Example:

"US"

end_user_type

enum<string>

End user type (if not using regulation_sid)

Available options:

individual,

business

number_type

enum<string>

Number type (if not using regulation_sid)

Available options:

local,

mobile,

tollfree

Response

Regulatory bundle created

sid

string

friendly_name

string

status

enum<string>

Available options:

draft,

pending-review,

in-review,

twilio-rejected,

twilio-approved,

provisionally-approved

regulation_sid

string

account_sid

string

email

string

date_created

string<date-time>

date_updated

string<date-time>

request_parameters

object

Show child attributes

note

string

Create Regulatory Bundle

curl --request POST \
  --url https://api.kallabot.com/regulatory/bundles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "friendly_name": "Business Phone Number Bundle",
  "email": "[email protected]",
  "iso_country": "US",
  "end_user_type": "business",
  "number_type": "local"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    friendly_name: 'Business Phone Number Bundle',
    email: '[email protected]',
    iso_country: 'US',
    end_user_type: 'business',
    number_type: 'local'
  })
};

fetch('https://api.kallabot.com/regulatory/bundles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kallabot.com/regulatory/bundles"

payload = {
    "friendly_name": "Business Phone Number Bundle",
    "email": "[email protected]",
    "iso_country": "US",
    "end_user_type": "business",
    "number_type": "local"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "sid": "<string>",
  "friendly_name": "<string>",
  "status": "draft",
  "regulation_sid": "<string>",
  "account_sid": "<string>",
  "email": "<string>",
  "date_created": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "request_parameters": {
    "iso_country": "<string>",
    "end_user_type": "<string>",
    "number_type": "<string>",
    "regulation_sid": "<string>"
  },
  "note": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}