Skip to main content

Update an embed

Updates the specified embed by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters​

title
string
Title of the embed.
url
string
The URL of the embed.
visibility
enum
Visibility of the embed. One of private, internal, shared.

Returns​

Returns the embed object if the update succeeded. Throws an error if update parameters are invalid.

put
/api/embeds/{id}
curl -X PUT https://{workspace}.kitchen.co/api/embeds/{id} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "archived_at": "2024-03-07T07:47:02+00:00",
  "created_at": "2024-03-12T12:54:41+00:00",
  "id": "pe_12b3c33d7f42bcbd1b373ff9",
  "title": "The embed title",
  "updated_at": "2024-03-12T12:54:41+00:00",
  "url": "https://example.com",
  "visibility": "internal"
}