REST ClientFabricRELAY Applications

update

View as MarkdownOpen in Claude

Replace a RELAY application resource. Uses PUT for full replacement.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Relay Application.

Request

namestringOptional
Name of the Relay Application
topicstringOptional
Topic of the Relay Application
call_status_callback_urlstringOptional
Call status callback URL

Response

idstringRequiredformat: "uuid"
Unique ID of the Relay Application.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the Relay Application Fabric Resource
typeenumRequired
Type of the Fabric Resource
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
relay_applicationobjectRequired
Relay Application data.

Response Example

Response
1{
2  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4  "display_name": "Customer Service Bot",
5  "type": "relay_application",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "relay_application": {
9    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10    "name": "Booking Assistant",
11    "topic": "booking",
12    "call_status_callback_url": "https://example.com/callbacks"
13  }
14}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com",
7});
8
9const updated = await client.fabric.relayApplications.update("resource-id", { name: "updated-name" });
10console.log(`Updated: ${updated.display_name}`);