Newsletters

Upload or register newsletter asset

post/newsletter-assets

Request

Base URL: https://shipmail.to/api/v1
URL: https://shipmail.to/api/v1/newsletter-assets
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

filenamestring

Headers

X-Shipmail-Filenamestring

Idempotency-Keystring

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

urlstring uri required

filenamestring

thumbnail_urlstring uri

Response

Uploaded asset.

object'newsletter_asset' required

idstring required

kind'image' | 'video' required

filenamestring required

content_typestring required

byte_sizeinteger required

checksum_sha256string required

urlstring uri required

thumbnail_urlstring uri nullable

thumbnail_content_typestring nullable

thumbnail_byte_sizeinteger nullable

duration_secondsnumber nullable

widthinteger nullable

heightinteger nullable

created_atstring date-time required

image_urlstring uri nullable required

video_urlstring uri nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.