[Deprecated] Update A Live Entity
Updates a specified live entity's name and/or description. Any parameters not provided will be left unchanged.
/v1/live_entities/:id
PUT
Path Parameters
Name | Type | Description |
---|---|---|
id | string | The identifier of the live entity to be updated. |
Request Body
Name | Type | Description |
---|---|---|
name | string | The new name of live entity to be updated. This parameter cannot be empty in your body request. |
description | string | The new description of the live entity to be updated. This version does not support update description as an empty string, in case your old description is incorrect, replace it with the new one that makes more sense. |
relay | array | The new relay of the live entity to be updated. It must include the object(s) with url, key, and name (optional) attributes, if you want to clear all your relay setting, send relay: [{}] when updating the live entity. |
Last updated