Send

Upload Media File

This function allows you to upload a file to be sent as an MMS or WhatsApp to the user. The response will include MediaDetails, which will have an object called mediaPath. The mediaPath object contains an array of details about the uploaded file such as fileName, extension, fileSaveId, mimetype, and url.

Supported file types: JPG, PNG, GIF, MP4, MP3, PDF

MMS File size limit(US): 950 KB
MMS File size limit(Canada): 750 KB
WhatsApp File size limit: 15 MB

post/orgunit/{orgunitId}/messages/file

Request

Base URL
https://api-docs.ministrybytext.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/ministrybytext/apis/pbt-api-documentation/docs/orgunit/:orgunitId/messages/file/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgunitIdstring required

orgunitId

Query parameters

UsedFor'whatsapp'

Required for sending WhatsApp file.

Request body multipart/form-data

filestring binary

Response

Success

appCodestring nullable

messagestring nullable

isErrorboolean

Changes

No recorded changes to this operation across all 5 revisions of this API.