Update cXML application

Updates a cXML Application by ID

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.

Updates a cXML Application by ID #### 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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a cXML Application.

Request

This endpoint expects an object.

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

The request has succeeded.

idstringformat: "uuid"

Unique ID of the cXML Application.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the cXML Application Fabric Resource

typeenum

Type of the Fabric Resource

Allowed values:

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

cxml_applicationobject

cXML Application data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	curl -X PUT https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id \
2	-H "Content-Type: application/json" \
3	-u "<project_id>:<api_token>" \
4	-d '{}'

1	{
2	"id": "993ed018-9e79-4e50-b97b-984bd5534095",
3	"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4	"display_name": "Reception App",
5	"type": "cxml_application",
6	"created_at": "2024-05-06T12:20:00Z",
7	"updated_at": "2024-05-06T12:20:00Z",
8	"cxml_application": {
9	"id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
10	"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
11	"friendly_name": "Reception App",
12	"voice_url": "https://example.com/voice/incoming",
13	"voice_method": "GET",
14	"voice_fallback_url": "https://example.com/voice/fallback",
15	"voice_fallback_method": "GET",
16	"status_callback": "https://example.com/voice/status",
17	"status_callback_method": "GET",
18	"sms_url": "https://example.com/message/incoming",
19	"sms_method": "GET",
20	"sms_fallback_url": "https://example.com/message/fallback",
21	"sms_fallback_method": "GET",
22	"sms_status_callback": "https://example.com/message/status",
23	"sms_status_callback_method": "GET"
24	}
25	}