Postman v2 Guide
Go to Postman v2
  • Postman v2 API Docs
    • 🤖About Postman v2
      • Postman v2 SLOs
    • Postman v2 SMS API user documentation
    • 📶Service Status
    • ⏰Postman Guide latest updates
    • 🏋️Important dates
    • 🛒Useful Links
  • Postman v2 general user guide (MoP)
    • 🔐Logging into Postman v2
    • 📢Create Campaign
      • Message Preview
      • Language tab
      • Message content
      • Character count
    • 🪵Message Logs
    • Deleting campaigns
  • Postman v2 Admin Portal, for UI Users (MOP)
    • 📤Sending messages via the Admin Portal
  • Postman v2 Admin Portal for API users (MOP)
    • ⚙️Campaign Settings
    • 🖥️Sending Messages via Postman API
  • 🪪Sending SMSes using NRIC
  • Postman v2 admin portal, for UI users (Internal)
    • Internal SMS
    • Information for new Twilio users
    • Summary of Costs
    • How do I onboard Postman v2 Internal SMS
      • 1. Sender ID Registration
      • 2. Sign up for a Twilio account
      • 3. Set up your Twilio account
      • 4. Fill your Twilio credentials on Postman
        • What if I need to buy a phone number?
      • 5. Send a Test Message
  • General notes for API users
    • 🗒️Overview
    • Authentication
    • API Errors
    • Message Delivery Errors
    • Pagination
    • Rate Limits
  • Endpoints for API users
    • 📞Endpoints for API users
    • The message object
    • Single Send
    • Single Send - Retry
    • Retrieve Message
    • Batch Send
    • Batch Send - Retry
    • Retrieve Batch
    • Retrieve Campaign Message
  • SFTP
    • 📂SFTP Integration
    • 🗝️Generating SSH Keys
    • Connecting to the SFTP server
    • Sending messages via SFTP
    • Checking whether sending via SFTP is successful
  • Load Test
    • Load Test Booking Requirement
  • FAQ
    • ❓Postman v2 FAQ
      • General Q&A
      • Sending emails to users (Legacy Postman)
      • Access related inquiries
      • Platform access related inquiries
      • User Access
      • API keys generation and IP Address whitelisting
      • Delivery Report
      • Messaging
      • Message Statuses
      • Integration and configuration related inquiries
      • Delivery rate
      • File types
      • SFTP and other integration methods
    • 💻Postman v2 API FAQ
      • API keys generation
      • Campaign related inquiries
      • API related inquiries
      • IP Address related inquiries
    • 🗃️SFTP and Other integration methods
  • Legal
    • Terms & Condition
    • Privacy Policy
  • Call App
    • Terms & Condition
    • Privacy Policy
Powered by GitBook
On this page
Export as PDF
  1. SFTP

Sending messages via SFTP

PreviousConnecting to the SFTP serverNextChecking whether sending via SFTP is successful

Last updated 11 months ago

To send messages in bulk, you must prepare a CSV file where each column, in addition to recipient and language, represents a value corresponding to the campaign’s template parameter.

The examples below is based on the following campaign template:

The campaign template is configured on the admin portal during campaign creation.

Please refer to on more information on creating a message on the admin portal.

Example campaign template
Dear {{recipient_name}},

This is to inform you that we have received your request for {{topic}}.

We will contact you again when we have processed your request. Thank you.

An example CSV file for the above template can be found below, along with an explanation of the various fields in the file.

Example CSV file
recipient,language,recipient_name,topic
6599999999,english,Emily Yeo,passport application #12345F
6599999998,chinese,James Tan,passport application #67890A

CSV file fields


recipient string (Mandatory field)

For messages sent through the sms channel, the recipient will be the mobile phone number of the recipient, together with the country code of the recipient without including + in front.

eg. 6591234567 is a recipient string for a Singapore (65) phone number (91234567)


language string (Mandatory field)

This is the language of the message template used to send this message.

This are the possible values english, chinese, malay, or tamil.


recipient_name string (Optional field - depending on your message template content)


topic string (Optional field - depending on your message template content)


Subsequently, you will need to upload this file using the following command:

put <file to upload>

Please be aware that our system does not generate output files. The result of a file upload will be communicated to you via email.

create message