Skip to main content
POST
/
api
/
v1
/
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
}
'
{
  "api_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "message": "changed"
}
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

FieldTypeRequiredDescription
app_namestringNoNew name for the application. Letters, numbers, -, and _ only.
answer_urlstringNoThe URL invoked when a call executes this application. Must return valid VobizXML.
answer_methodstringNoHTTP method used to call answer_url. One of GET or POST. Defaults to POST.
hangup_urlstringNoURL notified when the call hangs up.
hangup_methodstringNoHTTP method used to call hangup_url. One of GET or POST. Defaults to POST.
fallback_answer_urlstringNoInvoked by Vobiz only if answer_url is unreachable, times out, or returns invalid VobizXML. Must itself return valid VobizXML.
fallback_methodstringNoHTTP method used to call fallback_answer_url. One of GET or POST. Defaults to POST.
message_urlstringNoURL notified by Vobiz when an inbound message is received.
message_methodstringNoHTTP method used to call message_url. One of GET or POST. Defaults to POST.
default_number_appbooleanNoIf true, associates all newly created Vobiz numbers without an app_id to this application. Does not re-route existing numbers.
default_endpoint_appbooleanNoIf true, associates all newly created Vobiz endpoints without an application to this application. Does not re-route existing endpoints.
application_typestringNoThe type of application. Typically XML.
default_appbooleanNoWhether this is the account-level default application.
enabledbooleanNoWhether the application is enabled.
log_incoming_messagebooleanNoControls whether incoming messages to phone numbers associated with this application are logged.
public_uribooleanNoWhether the application’s sip_uri is reachable by external SIP systems.
sip_transfer_methodstringNoHTTP method used for SIP transfer callbacks. One of GET or POST.
sip_transfer_urlstringNoURL notified during a SIP transfer.
sip_uristringNoSIP 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"
}

​
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