Upload a media object

client.mediaObjects.upload(, ?): 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

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

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

console.log(response.mediaObjectId);

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

Returns Examples

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