Sender

Set sender mode

type=tinysend resets to the default. type=custom_domain needs name, email (local part), domain — creates the domain in Postmark and returns the DNS records to add. type=gmail is coming soon.

put/lists/{listId}/sender

Request

  • Base URL: https://api.tinysend.com/v1
  • URL: https://api.tinysend.com/v1/lists/{listId}/sender
  • Auth: HTTP bearer

Path parameters

listIdstring required

Request body

type'tinysend' | 'custom_domain' | 'gmail' required

tinysend = default @tinysend.com, custom_domain = your own domain via DNS, gmail = coming soon

namestring
emailstring

local part only, the bit before the @

domainstring

Example request

{
  "name": "James",
  "email": "james",
  "domain": "acme.com"
}

Response

Sender updated

typestring required
from_addressstring required
status'default' | 'pending' | 'verified' | 'failed' required
next_stepstring required

Changes

No recorded changes to this operation across all 1 revision of this API.