Create an SMTP credential

Request body

• namestringrequired

  A name for your team, like Website contact form.

• domain_idstringrequired

  The domain this key sends from. Copy its ID from the domain's page in the dashboard, or read it from GET /domains.

• allowed_ipsarray<string>

  The IP addresses allowed to use this key when ip_allowlist_enabled is true. Any other address is refused.

• ip_allowlist_enabledboolean

  Accept this key only from allowed_ips.

• expires_atstring

  Optional. When the key stops working, ISO 8601. Leave it out for a key that does not expire.

• hourly_limitinteger

  Optional. The most emails this key may send in an hour.

• daily_limitinteger

  Optional. The most emails this key may send in a day.

• tracking_enabledboolean

  Track opens and clicks in mail sent with this key. Defaults to false for an app (transactional) key, so its links stay on your own domain, and true for a marketing key.

• streamstringtransactional | marketing

  transactional for emails your app sends one at a time, like receipts and sign-in codes; marketing for newsletters and promotions. They go out from different addresses so one cannot harm the other.

Request

curl -X POST 'https://app.mailyte.com/api/v1/smtp-credentials' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Website contact form",
    "domain_id": "01JBT8XQ2M9WYC3K4F6R7S8T9V"
  }'

const response = await fetch('https://app.mailyte.com/api/v1/smtp-credentials', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Website contact form",
    "domain_id": "01JBT8XQ2M9WYC3K4F6R7S8T9V"
  }),
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/smtp-credentials",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "name": "Website contact form",
      "domain_id": "01JBT8XQ2M9WYC3K4F6R7S8T9V"
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/smtp-credentials', [
    'name' => 'Website contact form',
    'domain_id' => '01JBT8XQ2M9WYC3K4F6R7S8T9V',
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/smtp-credentials")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "name": "Website contact form",
  "domain_id": "01JBT8XQ2M9WYC3K4F6R7S8T9V"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringsmtp_credential
  • idstring

    Unique identifier for the credential.

  • namestring

    Your name for the key. It is not used to sign in.

  • usernamestring

    The SMTP username, to set in your mail library. Delivery events name it. Safe to log.

  • statestringactive | paused | revoked | inactive | expired | suspended | pending_review | provisioning | failed | deleting

    Whether the key can send. Only active can. - deleting, failed: being removed, or setup failed. - pending_review: a marketing key waiting for approval. - expired: past expires_at. - suspended: switched off by us or after delivery failures. - inactive: retired after a long time unused (the owner was warned three times). Turning it back on keeps the same username and secret. - paused: on hold because it suddenly sent far more than usual or from a new host. Its mail waits rather than bouncing. The hold lifts by itself (after six hours by default), or now with POST /smtp-credentials/{credential}/resume.

  • streamstringtransactional | marketing

    Which lane mail sent with this credential is treated as. The stream decides reputation handling and marketing gating; it is not a label.

  • domainobject

    The one domain this key may send as.

    • idstring

      The domain's ID. Always set.

    • namestring

      The domain's name. Some responses leave it null; use domain.id, or read the key from GET /smtp-credentials.

  • ip_allowlistobject

    Enforced by the mail server at AUTH time, not by this API. enabled: false with a populated list is a configured allowlist that is currently off, not a contradiction.

    • enabledboolean
    • addressesarray<string>

      IPv4/IPv6 addresses or CIDR ranges.

  • limitsobject

    Limits for this key alone, below your plan's limits.

    • hourlyinteger

      Recipients per hour for this key. Null means no key limit is set; your plan's limit still applies.

    • dailyinteger

      Recipients per day for this key. Null means no key limit is set; your plan's limit still applies.

  • tracking_enabledboolean

    Whether open and click tracking is injected into HTML sent with this credential.

  • last_used_atstring

    When this key last signed in to send. It can be up to an hour behind. Null means no use has been seen yet, which is not proof the key is idle. For a live figure, use GET /smtp-credentials/{credential}/usage.

  • expires_atstring

    When the key stops working, in ISO 8601 UTC. Null means it never expires (the default). Null does not mean expired.

  • created_atstring

    ISO 8601 UTC.

  • passwordstring

    The SMTP password. **Shown only when the key is created or rotated**, and never again: save it now. If you lose it, rotate the key.

  • smtpobject

    The SMTP host and port to send with, returned only when the key is created. They are the same for every key, so you can save them once.

    • hoststring

      SMTP submission host.

    • portinteger

      SMTP submission port.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.