POST/api/plugin_settings/{id}/image

Upload an image for a webhook_image plugin

Send the image as JSON with the bytes in base64, or as the raw request body with its image Content-Type (not multipart form data). PNG, JPEG and WebP.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
Plugin setting id or uuid
image_base64stringrequired
The image bytes, base64 encoded

5 status codes
200Full-color image on a color device
dataobjectoptional
401Numeric id without an API key
404Not found
422Image too large
429Rate limited

Error handling

A 401 is returned: Numeric id without an API key. A 404 is returned: Not found. A 422 is returned: Image too large. A 429 is returned: Rate limited.