update | SignalWire

Replace a cXML application resource. Uses PUT, so the full resource body must be provided.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a cXML Application.

Request

display_namestringOptional

Display name of the cXML Application

account_sidstringOptionalformat: "uuid"

Project ID for the cXML Application

voice_urlstringOptional

URL to handle incoming calls

voice_methodenumOptional

HTTP method for voice URL

voice_fallback_urlstringOptional

Fallback URL for voice errors

voice_fallback_methodenumOptional

HTTP method for voice fallback URL

status_callbackstringOptional

URL to receive status callbacks

status_callback_methodenumOptional

HTTP method for status callbacks

sms_urlstringOptional

URL to handle incoming messages

sms_methodenumOptional

HTTP method for SMS URL

sms_fallback_urlstringOptional

Fallback URL for SMS errors

sms_fallback_methodenumOptional

HTTP method for SMS fallback URL

sms_status_callbackstringOptional

URL to receive SMS status callbacks

sms_status_callback_methodenumOptional

HTTP method for SMS status callbacks

Response

idstringRequiredformat: "uuid"

Unique ID of the cXML Application.

project_idstringRequiredformat: "uuid"

Unique ID of the Project.

display_namestringRequired

Display name of the cXML Application Fabric Resource

typeenumRequired

Type of the Fabric Resource

created_atdatetimeRequired

Date and time when the resource was created.

updated_atdatetimeRequired

Date and time when the resource was updated.

cxml_applicationobjectRequired

cXML Application data.

Response Example

Response

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception App",
  "type": "cxml_application",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "cxml_application": {
    "id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
    "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
    "friendly_name": "Reception App",
    "voice_url": "https://example.com/voice/incoming",
    "voice_method": "GET",
    "voice_fallback_url": "https://example.com/voice/fallback",
    "voice_fallback_method": "GET",
    "status_callback": "https://example.com/voice/status",
    "status_callback_method": "GET",
    "sms_url": "https://example.com/message/incoming",
    "sms_method": "GET",
    "sms_fallback_url": "https://example.com/message/fallback",
    "sms_fallback_method": "GET",
    "sms_status_callback": "https://example.com/message/status",
    "sms_status_callback_method": "GET"
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
const updated = await client.fabric.cxmlApplications.update("app-id", {
  display_name: "updated-cxml-app",
});
console.log("Updated:", updated.display_name);