Skip to content

Update Image

PATCH/images/:id

Update an existing image. Only the attributes you include are changed.

Attributes

AttributeTypeDescription
typestring
providerstringImage provider, e.g. "s3".
public_idstringProvider-specific image key.
urlstring
base64string
descriptionstring
titlestring
linkstring
orderstring
widthstring
heightstring
contentstring
blockIdstring
blockStyleIdstring
themeIdstring
eventIdstring
workspaceIdstring

Fields marked with * are required.

Request

js
import Confetti from 'confetti'

const confetti = new Confetti({ apiKey: 'your-key' })

const image = await confetti.images.update(4242, {
  title: 'example',
})
sh
curl -X PATCH "https://api.confetti.events/images/4242" \
  -H "Content-Type: application/json" \
  -H "Authorization: apikey your-key" \
  -d '{
  "data": {
    "type": "image",
    "id": "4242",
    "attributes": {
      "title": "example"
    }
  }
}'