Skip to main content

Customer Setup SFTP

This guide explains what you, as the customer, need to provide and configure to enable the SFTP integration between your SFTP server and the Marketplace.

1. Prerequisites​

Before proceeding, ensure you have the following:

  • An SFTP server reachable from the internet (port 22, standard SFTP port — not configurable per integration).
  • A username and password for that server. (Note: only password authentication is supported today — SSH key-based authentication is not available.)
  • A remote base path/directory on the SFTP server where files should be delivered. The folder will be created automatically if it does not already exist.
  • Access to the Marketplace platform.

2. What to Provide​

Unlike Google Ads / Facebook Ads, the SFTP integration does not use an OAuth authorization flow. Instead, you provide connection details directly to the delivery team:

FieldDescriptionExample
Host Name (Required)Hostname or IP address of your SFTP serversftp.example.com
Username (Required)Username used to authenticate to the SFTP servercm-export-user
Password (Required)Password for the above user(shared securely, not via email/chat)
Base Path (Required)Remote directory where exported CSV files should be uploaded/exports/cm-marketplace/
Sync Schedule (Required)Cron expression for automatic exportInform the delivery team when you would like exports to run, e.g. daily at a specific time, weekly on Sundays, or monthly on the 1st.
AddressBook GroupsThe contact groups you want exportedSelect from the dropdown (see below)

Security note: Share the SFTP password with the delivery team over a secure channel, not plain email or chat.

3. Manage Groups for Syncing​

If you want to export specific groups from your Address Book to your SFTP server, follow these steps:

Steps to Manage Groups​

  1. In the Marketplace platform, go to the Integration Details section under SFTP.
  2. Click on Manage Groups.
  3. Select the groups you want exported to your SFTP server.
  4. Save the changes.

Each selected group is exported as its own CSV file. If no groups are selected, exports will fail.

4. What Happens During Export​

For each selected AddressBook group, on the configured schedule (or when triggered manually):

  • Contacts are retrieved from the AddressBook group.
  • A CSV file is generated containing all contact fields (id, name, email, phone, group, opt-out status, etc.).
  • The file is named {group-name}--{timestamp}.csv and uploaded to your configured Base Path.
  • Files are uploaded safely (written first, then finalized) so you will never see a partially-written file. A file with the same final name is overwritten.

5. Important Notes​

  • Authentication — Password-based only. SSH key authentication is not currently supported.
  • Port — Fixed at 22 (standard SFTP). Not configurable.
  • File format — CSV, UTF-8 encoded, comma-delimited, with a header row.
  • Re-authorization — Not applicable; if your SFTP credentials change (e.g. password rotation), notify the delivery team to update the integration.