Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Images

Upload image file

With this endpoint you can upload an image file directly from your computer.

File Requirements:

  • Supported formats: JPEG, PNG, GIF, WebP
  • Maximum file size: 5MB

Scopes: images.write

post/images/upload

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

Image uploaded

createdAtstring

Image creation timestamp.

heightinteger

Image height in pixels.

idstring

Unique image identifier.

namestring

Image name.

sizeinteger

Image size in bytes.

typestring

MIME type of the image.

urlstring

Public CDN URL of the image.

widthinteger

Image width in pixels.

Example response

{
  "createdAt": "2026-01-15T10:30:00Z",
  "height": 1080,
  "id": "507f1f77bcf86cd799439011",
  "name": "my-image",
  "size": 102400,
  "type": "image/jpeg",
  "url": "https://cdn.example.com/image.jpg",
  "width": 1920
}