Upload

API Reference

Media Objects

Upload a media object

client.mediaObjects.upload(MediaObjectUploadParams { media_url } body, RequestOptionsoptions?): MediaObjectUploadResponse { mediaObjectId, message, status }

post/api/upload-media-object

Upload a media file to Sendblue's CDN for use in messages

ParametersExpand Collapse

body: MediaObjectUploadParams { media_url }

media_url: string

URL of the media file to upload

formaturi

ReturnsExpand Collapse

MediaObjectUploadResponse { mediaObjectId, message, status }

mediaObjectId?: string

message?: string

status?: string

Upload a media object

typescript

• http
• typescript
• python

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const response = await client.mediaObjects.upload({ media_url: 'https://example.com/image.jpg' });

console.log(response.mediaObjectId);

200 example

{
  "mediaObjectId": "abc123def456",
  "message": "File uploaded successfully",
  "status": "OK"
}

Returns Examples

200 example

{
  "mediaObjectId": "abc123def456",
  "message": "File uploaded successfully",
  "status": "OK"
}