Envoi
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
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.
Retourne
The two lanes.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
streamstringObligatoireThe lane,
transactionalorbroadcast.L'un de"transactional""broadcast"
Retourne
The lane, active again.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401404422500Catalogue des erreurs
Aussi disponible dans
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.
Retourne
The dedicated IPs.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
ipstringObligatoireThe IP address, as the list returns it.
Retourne
The dedicated IP.
Erreurs
- 404
resource_not_found: the workspace has no dedicated IP with that address.
Les erreurs que toute opération peut renvoyer400401403422500Catalogue des erreurs
Aussi disponible dans
Objets
DedicatedIpobject
objectstringObligatoire- L'un de
"dedicated_ip" ipstringObligatoirestatusstringObligatoirewarmingwhile the IP is being warmed up,readyonce all of the workspace's mail leaves through it.L'un de"available""warming""ready""released"poolstringObligatoireThe pool the IP sends through.
Peut être nullpoolStatusstringObligatoire- Peut être nullL'un de
"pending""warming""active""releasing""released""failed" warmupPercentintegerObligatoire- Au moins 0Au plus 100
assignedAtstringObligatoire- Peut être nullFormat
date-time readyAtstringObligatoire- Peut être nullFormat
date-time checkedAtstringObligatoireWhen the warm-up was last read.
Peut être nullFormatdate-time
DedicatedIpListobject
objectstringObligatoire- L'un de
"list" dataDedicatedIp[]Obligatoire
SendingStreamobject
objectstringObligatoire- L'un de
"sending_stream" streamstringObligatoire- L'un de
"transactional""broadcast" statusstringObligatoirepausedholds every new message on the lane until it is resumed. Only the broadcast lane pauses.L'un de"active""paused"pausedAtstringObligatoire- Peut être nullFormat
date-time pausedReasonstringObligatoireWhich limit was passed, or null on an active lane.
Peut être nullL'un de"bounce_rate""complaint_rate"resumedAtstringObligatoireWhen the lane was last resumed. The count in
windowstarts no earlier than this.Peut être nullFormatdate-timewindowobjectObligatoiresincestringObligatoire- Format
date-time untilstringObligatoire- Format
date-time recipientsintegerObligatoireRecipients the lane handed over for delivery in the window.
bouncedintegerObligatoirecomplainedintegerObligatoireRecipients who reported the mail as spam.
bounceRatenumberObligatoireBounced over recipients, from 0 to 1.
complaintRatenumberObligatoireComplained over recipients, from 0 to 1.
limitsobjectObligatoirebounceRatenumberObligatoireThe broadcast lane pauses above this bounce rate.
complaintRatenumberObligatoireThe broadcast lane pauses above this complaint rate.
minimumRecipientsintegerObligatoireThe rates are only judged once the lane reached this many recipients in the window.
windowDaysintegerObligatoire
SendingStreamListobject
objectstringObligatoire- L'un de
"list" dataSendingStream[]Obligatoire