Update an Application

POSThttps://api.vobiz.ai/api/v1/Account/{authID}/Application/{appID}/

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

Authentication Required:

• Bearer Token: Include in Authorization header
• X-Auth-ID Header: Your account ID (e.g., {Auth_ID})

Important Notes:

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

Parameters

Request Parameters

Name	Type	Description
`answer_url`	string	The URL invoked when a call executes this application.
`answer_method`	string	The method used to call the answer_url. Defaults to POST.
`hangup_url`	string	The URL notified when the call hangs up.
`hangup_method`	string	The method used to call the hangup_url. Defaults to POST.
`fallback_answer_url`	string	Invoked by Vobiz only if answer_url is unavailable or the XML response is invalid.
`fallback_method`	string	The method used to call the fallback_answer_url. Defaults to POST.
`message_url`	string	The URL that is notified by Vobiz when an inbound message is received.
`message_method`	string	The method used to call the message_url. Defaults to POST.
`default_number_app`	boolean	If set to true, associates all newly created Vobiz numbers that have not specified an app_id to this application.
`default_endpoint_app`	boolean	If set to true, associates all newly created Vobiz endpoints that have not specified an app_id to this application.
`subaccount`	string	ID of the subaccount with which this application is associated.
`log_incoming_messages`	boolean	Controls whether incoming messages to phone numbers associated with the Application are logged in Vobiz systems.

Request Body

JSON

{
  "app_name": "Updated Application Name",
  "answer_url": "https://example.com/updated-answer",
  "answer_method": "POST",
  "hangup_url": "https://example.com/updated-hangup",
  "hangup_method": "POST",
  "fallback_answer_url": "https://example.com/updated-fallback",
  "fallback_method": "POST",
  "message_url": "https://example.com/updated-message",
  "message_method": "POST",
  "default_number_app": true,
  "default_endpoint_app": false
}

Response Examples

Success Response (200 OK)

{
  "api_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "changed",
  "app_id": "12345678",
  "resource_uri": "/v1/Account/{Auth_ID}/Application/12345678/"
}

Error Response (400 Bad Request)

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

Error Response (404 Not Found)

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

cURL Example

cURL

curl -X POST https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Application/12345678/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_name": "Updated IVR System",
    "default_number_app": true
  }'

Retrieve an Application