Upload an image (PNG, JPEG or GIF, up to 5 MB)

POST

/api/v1/workspaces/{workspace}/media

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/media"

  payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"file\"\r\nContent-Type: image/png,image/jpeg,image/gif,application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/media';
const form = new FormData();
form.append('file', 'file');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/media \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Permission: campaigns:edit

The file is validated by its content, not its name. Uploading the same file twice returns the stored image.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Body

multipart/form-data

object

file

required

PNG, JPEG or GIF, up to 5 MB

string format: binary

Responses

201

Created

application/json

object

contentType

required

string

Allowed values: image/png image/jpeg image/gif

createdAt

required

string format: date-time

createdBy

required

string

fileName

required

string

hasAlpha

required

Transparent pixels (logos survive dark mode)

boolean

height

required

integer format: int64

required

string

sizeBytes

required

integer format: int64

url

required

Root-relative URL; emails get the absolute public URL

string

width

required

integer format: int64

Example

{
  "contentType": "image/png"
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}