Update an Application

POST

api

Account

{auth_id}

Application

{app_id}

Update an Application

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "app_name": "Updated Application Name",
  "default_number_app": true
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/"

payload = {
    "app_name": "Updated Application Name",
    "default_number_app": True
}
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({app_name: 'Updated Application Name', default_number_app: true})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "api_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "message": "changed"
}

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

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

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/

Modify an application. You can update any subset of fields (partial update).

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Important Notes:

Fields not provided will remain unchanged
sub_account cannot be changed after creation

Parameters

Field	Type	Required	Description
`app_name`	string	No	New name for the application. Letters, numbers, `-`, and `_` only.
`answer_url`	string	No	The URL invoked when a call executes this application. Must return valid VobizXML.
`answer_method`	string	No	HTTP method used to call `answer_url`. One of `GET` or `POST`. Defaults to `POST`.
`hangup_url`	string	No	URL notified when the call hangs up.
`hangup_method`	string	No	HTTP method used to call `hangup_url`. One of `GET` or `POST`. Defaults to `POST`.
`fallback_answer_url`	string	No	Invoked by Vobiz only if `answer_url` is unreachable, times out, or returns invalid VobizXML. Must itself return valid VobizXML.
`fallback_method`	string	No	HTTP method used to call `fallback_answer_url`. One of `GET` or `POST`. Defaults to `POST`.
`message_url`	string	No	URL notified by Vobiz when an inbound message is received.
`message_method`	string	No	HTTP method used to call `message_url`. One of `GET` or `POST`. Defaults to `POST`.
`default_number_app`	boolean	No	If `true`, associates all newly created Vobiz numbers without an `app_id` to this application. Does not re-route existing numbers.
`default_endpoint_app`	boolean	No	If `true`, associates all newly created Vobiz endpoints without an `application` to this application. Does not re-route existing endpoints.
`application_type`	string	No	The type of application. Typically `XML`.
`default_app`	boolean	No	Whether this is the account-level default application.
`enabled`	boolean	No	Whether the application is enabled.
`log_incoming_message`	boolean	No	Controls whether incoming messages to phone numbers associated with this application are logged.
`public_uri`	boolean	No	Whether the application’s `sip_uri` is reachable by external SIP systems.
`sip_transfer_method`	string	No	HTTP method used for SIP transfer callbacks. One of `GET` or `POST`.
`sip_transfer_url`	string	No	URL notified during a SIP transfer.
`sip_uri`	string	No	SIP URI associated with the application.

Every field is optional; send only what you want to change. sub_account is set at creation and cannot be modified here.

Request Body

JSON

{
  "app_name": "My Voice App",
  "answer_url": "https://example.com/answer",
  "answer_method": "POST",
  "hangup_url": "https://example.com/hangup",
  "hangup_method": "POST",
  "fallback_answer_url": "https://example.com/fallback",
  "fallback_method": "POST",
  "message_url": "https://example.com/message",
  "message_method": "POST",
  "default_number_app": false,
  "default_endpoint_app": false
}

Response Examples

{
  "api_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "message": "changed"
}

{
  "error": "invalid request parameters",
  "details": {
    "answer_url": "Enter a valid URL"
  }
}

{
  "error": "Application not found",
  "app_id": "12345678901234567"
}

cURL Example

cURL

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/12345678901234567/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_name": "My Voice App (renamed)",
    "default_number_app": true
  }'

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

app_id

string

required

Example:

"12345678"

Body

application/json

app_name

string

required

default_number_app

boolean

required

Response

Application updated

api_id

string

required

message

string

required

Update an Application

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "app_name": "Updated Application Name",
  "default_number_app": true
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/"

payload = {
    "app_name": "Updated Application Name",
    "default_number_app": True
}
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({app_name: 'Updated Application Name', default_number_app: true})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "api_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "message": "changed"
}

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

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

​Parameters

​Request Body

​Response Examples

​cURL Example

Authorizations

Path Parameters

Body

Response

Parameters

Request Body

Response Examples

cURL Example