Omnisend Images API

The Images API from Omnisend — 3 operation(s) for images.

OpenAPI Specification

omnisend-images-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Omnisend REST Analytics Images API
  description: 'Omnisend''s REST API for managing ecommerce email and SMS marketing

    automation. Exposes contacts, events, products, product categories,

    segments, campaigns, batches, email templates, email content, email

    universal layouts, images, brands, and analytics reports. Authentication

    uses an API key passed via the `X-API-KEY` header, or OAuth 2.0 with

    scopes such as `contacts.read`, `contacts.write`, `campaigns.read`,

    `campaigns.write`, `analytics.read`, etc.

    '
  version: v5
  contact:
    name: Omnisend
    url: https://api-docs.omnisend.com/
servers:
- url: https://api.omnisend.com/v5
  description: Omnisend REST API v5
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Images
paths:
  /images:
    get:
      tags:
      - Images
      summary: List images
      responses:
        '200':
          description: Images
    post:
      tags:
      - Images
      summary: Upload an image by URL
      responses:
        '201':
          description: Image created
  /images-upload:
    post:
      tags:
      - Images
      summary: Upload an image file
      responses:
        '201':
          description: Image uploaded
  /images/{id}:
    get:
      tags:
      - Images
      summary: Get an image
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Image
    delete:
      tags:
      - Images
      summary: Delete an image
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Image deleted
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.omnisend.com/oauth/authorize
          tokenUrl: https://api.omnisend.com/v5/oauth/token
          scopes:
            contacts.read: Read contacts
            contacts.write: Manage contacts
            campaigns.read: Read campaigns
            campaigns.write: Manage campaigns
            analytics.read: Read analytics