Update Relay Application

PUT 
/resources/relay_applications/:id

Updates a Relay Application by ID.

Request

Path Parameters

id uuidrequired

The ID of the Relay Application

application/json

Body

required

name string
Example: Booking Assistant
topic string
Example: booking
call_status_callback_url string
Example: https://booking.com/callbacks

Responses

200

A Relay Application

application/json

Schema

Schema

id uuid
Example: 993ed018-9e79-4e50-b97b-984bd5534095
project_id uuid
Example: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
display_name string
Example: Reception
type string
Example: relay_application
created_at date-time
Example: 2024-01-02T00:00:00Z
updated_at date-time
Example: 2024-01-02T00:00:00Z

relay_application

object

id uuid

A unique identifier for the Relay Application

name string

Example: Booking Assistant

topic string

Example: booking

call_status_callback_url string

Example: https://booking.com/callbacks

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "relay_application",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "relay_application": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Booking Assistant",
    "topic": "booking",
    "call_status_callback_url": "https://booking.com/callbacks"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Name must be present",
  "attribute": "name",
  "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
}