Skip to main content
POST
/
v1
/
metadata
/
upload-picture
Upload Picture
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/metadata/upload-picture \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ImageTypeLutId": 123,
  "EntityId": "<string>",
  "Image": "<string>",
  "ImageCrop": "<string>",
  "IsMonyx": true
}
'
{
  "ImageTypeLutId": 123,
  "Key": "<string>",
  "KeyName": "<string>",
  "Urls": {}
}

Authorizations

Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Body

application/json
ImageTypeLutId
integer<int32>

The identifier for the type of image being uploaded.

EntityId
string | null

The identifier of the entity to which the image is associated.

Image
string | null

The base64-encoded string representing the image to be uploaded.

ImageCrop
string | null

Optional cropping instructions for the image, if applicable.

IsMonyx
boolean

Indicates whether the image is associated with Monyx (a specific application or service).

Response

200 - application/json

The picture was successfully uploaded, and the response contains details about the uploaded picture.

ImageTypeLutId
integer<int32>

The identifier for the type of image that was uploaded.

Key
string | null

A unique key associated with the uploaded image.

KeyName
string | null

The name of the key associated with the uploaded image.

Urls
object

A map of URLs where the uploaded image can be accessed.