Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Images

Upload image by URL

With this endpoint you can upload an image from a publicly accessible URL. If the name is not provided, the filename will be extracted from the URL.

Scopes: images.write

post/images

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

namestring

Custom name for the image. If not provided, the filename will be extracted from the URL

urlstring required

URL of the image to upload. Must be publicly accessible (HTTPS, PNG, JPEG, GIF, or WebP, max 5MB)

Example request

{
  "name": "my-image",
  "url": "https://example.com/image.jpg"
}

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
}