Senden
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
How mail leaves the workspace. It travels in two lanes, so a newsletter cannot hold up or harm app mail: transactional for password resets, receipts and codes, and broadcast for newsletters. Each lane has its own queue and its own reputation numbers. The broadcast lane pauses itself when too many of its messages bounce or are reported as spam, and app mail keeps going out. A workspace with the dedicated IP add-on also sends from its own IP address.
GET/sending/streams
List the sending lanes
Both lanes with their state and their numbers for the last 7 days: recipients, bounces and complaints, the rates, and the limits the broadcast lane is held to. A paused lane says when and why. The count starts again when a lane is resumed.
Requires the emails:read scope.
Rückgabe
The two lanes.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/sending/streams/{stream}/resume
Resume a paused lane
Resumes the broadcast lane after it was paused for too many bounces or complaints. Broadcasts and messages that were on hold continue at once, and the 7 day count starts again from now, so clean the audience first. Only the workspace owner may do it, and an app acting for a person is asked for a verification code.
Requires the domains:write scope.
Pfadparameter
streamstringErforderlichThe lane,
transactionalorbroadcast.Einer von"transactional""broadcast"
Rückgabe
The lane, active again.
Fehler
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
stream_not_paused: the lane is not paused, so there is nothing to resume.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
GET/sending/dedicated-ips
List dedicated IPs
The dedicated sending IPs of the workspace, bought as an add-on with POST /billing/add-ons/checkout. A new IP is warmed up over several weeks: warmupPercent says how far it is, and until it reaches 100 part of the mail still leaves through the shared IPs. A workspace without the add-on gets an empty list and sends through the shared IPs.
Requires the domains:read scope.
Rückgabe
The dedicated IPs.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
GET/sending/dedicated-ips/{ip}
Read a dedicated IP
One dedicated IP of the workspace with its status and how far its warm-up has come.
Requires the domains:read scope.
Pfadparameter
ipstringErforderlichThe IP address, as the list returns it.
Rückgabe
The dedicated IP.
Fehler
- 404
resource_not_found: the workspace has no dedicated IP with that address.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
Objekte
DedicatedIpobject
objectstringErforderlich- Einer von
"dedicated_ip" ipstringErforderlichstatusstringErforderlichwarmingwhile the IP is being warmed up,readyonce all of the workspace's mail leaves through it.Einer von"available""warming""ready""released"poolstringErforderlichThe pool the IP sends through.
Kann null seinpoolStatusstringErforderlich- Kann null seinEiner von
"pending""warming""active""releasing""released""failed" warmupPercentintegerErforderlich- Mindestens 0Höchstens 100
assignedAtstringErforderlich- Kann null seinFormat
date-time readyAtstringErforderlich- Kann null seinFormat
date-time checkedAtstringErforderlichWhen the warm-up was last read.
Kann null seinFormatdate-time
DedicatedIpListobject
objectstringErforderlich- Einer von
"list" dataDedicatedIp[]Erforderlich
SendingStreamobject
objectstringErforderlich- Einer von
"sending_stream" streamstringErforderlich- Einer von
"transactional""broadcast" statusstringErforderlichpausedholds every new message on the lane until it is resumed. Only the broadcast lane pauses.Einer von"active""paused"pausedAtstringErforderlich- Kann null seinFormat
date-time pausedReasonstringErforderlichWhich limit was passed, or null on an active lane.
Kann null seinEiner von"bounce_rate""complaint_rate"resumedAtstringErforderlichWhen the lane was last resumed. The count in
windowstarts no earlier than this.Kann null seinFormatdate-timewindowobjectErforderlichsincestringErforderlich- Format
date-time untilstringErforderlich- Format
date-time recipientsintegerErforderlichRecipients the lane handed over for delivery in the window.
bouncedintegerErforderlichcomplainedintegerErforderlichRecipients who reported the mail as spam.
bounceRatenumberErforderlichBounced over recipients, from 0 to 1.
complaintRatenumberErforderlichComplained over recipients, from 0 to 1.
limitsobjectErforderlichbounceRatenumberErforderlichThe broadcast lane pauses above this bounce rate.
complaintRatenumberErforderlichThe broadcast lane pauses above this complaint rate.
minimumRecipientsintegerErforderlichThe rates are only judged once the lane reached this many recipients in the window.
windowDaysintegerErforderlich
SendingStreamListobject
objectstringErforderlich- Einer von
"list" dataSendingStream[]Erforderlich