Upload image for sequence messages

Upload an image file to Cloudflare R2 storage for use in SMS sequences. Supports JPEG, PNG, GIF, and WebP formats up to 10MB. Images are organized by workspace for security and isolation.

POST

https://api.channelautomation.com/api/media/upload

Authorization

bearerAuth
optional
bearerAuth

apiKey
optional
apiKey

Request body FORM-DATA required

image
string
required
Image file to upload

format: binary
workspaceId
string
required
Workspace ID

Returns

200

Image uploaded successfully

JSON

success
optional
boolean
url
optional
string
Public URL of uploaded image
fileName
optional
string
originalName
optional
string
size
optional
number

400

Bad request or validation error

JSON

success
optional
boolean
error
optional
string
Error message

500

Server error

JSON

success
optional
boolean
error
optional
string
Error message

Upload image for sequence messages

curl --request POST \
  --url https://api.channelautomation.com/api/media/upload \
  --form 'image=@<image>;type=application/octet-stream' \
  --form-string 'workspaceId=workspace-123'

import { readFile } from 'node:fs/promises';

const formData = new FormData();
formData.append('image', new Blob([await readFile('<image>')]), '<image>');
formData.append('workspaceId', 'workspace-123');

const url = 'https://api.channelautomation.com/api/media/upload';
const options = {method: 'POST', body: formData};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/media/upload"

files = [
    ("image", ("<image>", open("<image>", "rb"), "application/octet-stream"))
]
payload = { "workspaceId": "workspace-123" }

response = requests.post(url, data=payload, files=files)

print(response.text)

Response example

{
  "success": true,
  "url": "https://image.customerconnects.app/sequences/workspace123/abc123-def456.jpg",
  "fileName": "sequences/workspace123/abc123-def456.jpg",
  "originalName": "image.jpg",
  "size": 1024000
}

{
  "success": false,
  "error": "No image file provided"
}

{
  "success": false,
  "error": "Failed to upload image"
}