Update RELAY application

Updates a Relay 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 Relay 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) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Relay Application.

Request

This endpoint expects an object.

namestringOptional

Name of the Relay Application

topicstringOptional

Topic of the Relay Application

call_status_callback_urlstringOptional

Call status callback URL

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the Relay Application.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the Relay 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.

relay_applicationobject

Relay Application data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error