SuperSendAPI Docs

Sender API

A Sender is an email account to send out from. We only support Gmail right now mostly due to imap issues on the receiving end when using plain smtp providers like Sendgrid or AWS's SES

Create Sender

The API now strictly enforces field separation between the two update endpoints. Attempting to use connection fields in the settings endpoint (or vice versa) will result in an error.

bash
curl -X POST https://api.supersend.io/v1/sender --header "Authorization: Bearer <API_KEY>" --header "Content-Type: application/json" --data '{
  "id":"xxx",
  "TeamId":"xxx",
  "CampaignId":"xxx",
  "warm":false,
  "global_max_per_day":25,
  "email":"andrew@xxx",
  "signature":"<p>✌️,</p><p>Andrew</p>",
  "password":"xxx",
  "send_as":"Andrew"
}'
bash
curl -X GET 'https://api.supersend.io/v1/senders?TeamId=xxx' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json"
bash
curl -X GET 'https://api.supersend.io/v1/sender/<SenderId>/details' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json"

Get Senders

Use this endpoint ONLY for updating credential-related fields. This endpoint will perform connection checks.

bash
/v1/auto/sender/<SenderId>
bash
curl -X PUT https://api.supersend.io/sender/<SenderId> -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json" --data '{
  "TeamId":"xxx",
  "email":"andrew@xxx",
  "password":"xxx",
  "smtp_host":"smtp.gmail.com",
  "smtp_port":587,
  "smtp_secure":true,
  "imap_host":"imap.gmail.com",
  "imap_port":993,
  "imap_tls":true,
  "imap_username":"optional-username",
  "imap_password":"optional-password",
  "imap_disabled":false,
  "skip_connection_check":false  // Optional: set to true to bypass connection check
}'
bash
curl -X PUT https://api.supersend.io/v1/sender/<SenderId>/settings -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json" --data '{
  "TeamId":"xxx",
  "reply_to":"support@example.com",
  "send_as":"Andrew Smith",
  "signature":"<p>✌️,</p><p>Andrew</p>",
  "warm":true,
  "max_per_day":50,
  "global_max_per_day":100,
  "max_warm_per_day":5,
  "warm_email_ramp":3,
  "mail_warm_minimum":10,
  "disabled":false,
  "forward_to":"forward@example.com",
  "sent_mailbox":"[Gmail]/Sent Mail",
  "warm_start_date":"2023-01-01"
}'

Get Sender

Use this endpoint ONLY for updating non-credential settings. This endpoint never performs connection checks, providing faster updates for settings.

Update Sender

Sender fields fall into two distinct categories that must be updated through their respective endpoints:

bash
skip_connection_check

Field Categories

These fields can ONLY be updated through the main endpoint and will trigger connection checks:

Examples