Sign in
cXML Applications

Update cXML application

Changes where a cXML Application sends voice and messaging requests and callbacks. Compatibility Update application manages the same application by Application SID; use whichever identifier your integration holds.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

put/api/fabric/resources/cxml_applications/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a cXML Application.

Request body

display_namestring

Display name of the cXML Application

account_sidstring uuid

Universal Unique Identifier.

voice_urlstring

URL to handle incoming calls

voice_method'GET' | 'POST'

The method type to use for the URL

voice_fallback_urlstring

Fallback URL for voice errors

voice_fallback_method'GET' | 'POST'

The method type to use for the URL

status_callbackstring

URL to receive status callbacks

status_callback_method'GET' | 'POST'

The method type to use for the URL

sms_urlstring

URL to handle incoming messages

sms_method'GET' | 'POST'

The method type to use for the URL

sms_fallback_urlstring

Fallback URL for SMS errors

sms_fallback_method'GET' | 'POST'

The method type to use for the URL

sms_status_callbackstring

URL to receive SMS status callbacks

sms_status_callback_method'GET' | 'POST'

The method type to use for the URL

Example request

{
  "display_name": "Reception App",
  "voice_url": "https://example.com/voice/incoming",
  "voice_fallback_url": "https://example.com/voice/fallback",
  "status_callback": "https://example.com/voice/status",
  "sms_url": "https://example.com/message/incoming",
  "sms_fallback_url": "https://example.com/message/fallback",
  "sms_status_callback": "https://example.com/message/status"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the cXML Application Fabric Resource

type'cxml_application' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "display_name": "Reception App",
  "type": "cxml_application",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "cxml_application": {
    "friendly_name": "Reception App",
    "voice_url": "https://example.com/voice/incoming",
    "voice_fallback_url": "https://example.com/voice/fallback",
    "status_callback": "https://example.com/voice/status",
    "sms_url": "https://example.com/message/incoming",
    "sms_fallback_url": "https://example.com/message/fallback",
    "sms_status_callback": "https://example.com/message/status"
  }
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.