Upload

API Reference

Media Objects

Upload a media object

client.mediaObjects.upload(MediaObjectUploadParamsbody, RequestOptionsoptions?): mediaObjectIdstringmessagestringstatusstringMediaObjectUploadResponse

post/api/upload-media-object

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

Parameters

bodymedia_urlstringMediaObjectUploadParams

Hide ParametersShow Parameters

media_urlstring

URL of the media file to upload

formaturi

Returns

MediaObjectUploadResponse

Hide ParametersShow Parameters

mediaObjectIdstring

optional

messagestring

optional

statusstring

optional

HTTPTypeScript

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"
}