Upload background image for template

curl --request PATCH \
  --url https://api.yalg.ai/v1/carousel/templates/{templateId}/upload-background-image \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form backgroundImage='@example-file'

"<string>"

PATCH

carousel

templates

{templateId}

upload-background-image

Upload background image for template

curl --request PATCH \
  --url https://api.yalg.ai/v1/carousel/templates/{templateId}/upload-background-image \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form backgroundImage='@example-file'

"<string>"

Authorizations

x-api-key

string

header

default:yalg_live_your_api_key

required

YALG Developer API key. Send it in the x-api-key header from a server-side environment only.

Path Parameters

templateId

string

required

Carousel template identifier.

Example:

"018f9f46-9a0e-7afd-b13f-2f63f07aa4f2"

Body

multipart/form-data

backgroundImage

file

required

Background image/texture file (jpg, png, webp)

Response

Background image uploaded successfully

The response is of type file.

⌘I