Enviar
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Devolve
The two lanes.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
streamstringObrigatórioThe lane,
transactionalorbroadcast.Um de"transactional""broadcast"
Devolve
The lane, active again.
Erros
- 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.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Devolve
The dedicated IPs.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
ipstringObrigatórioThe IP address, as the list returns it.
Devolve
The dedicated IP.
Erros
- 404
resource_not_found: the workspace has no dedicated IP with that address.
Os erros que qualquer operação pode devolver400401403422500Catálogo de erros
Também disponível em
Objetos
DedicatedIpobject
objectstringObrigatório- Um de
"dedicated_ip" ipstringObrigatóriostatusstringObrigatóriowarmingwhile the IP is being warmed up,readyonce all of the workspace's mail leaves through it.Um de"available""warming""ready""released"poolstringObrigatórioThe pool the IP sends through.
Pode ser nullpoolStatusstringObrigatório- Pode ser nullUm de
"pending""warming""active""releasing""released""failed" warmupPercentintegerObrigatório- Pelo menos 0No máximo 100
assignedAtstringObrigatório- Pode ser nullFormato
date-time readyAtstringObrigatório- Pode ser nullFormato
date-time checkedAtstringObrigatórioWhen the warm-up was last read.
Pode ser nullFormatodate-time
DedicatedIpListobject
objectstringObrigatório- Um de
"list" dataDedicatedIp[]Obrigatório
SendingStreamobject
objectstringObrigatório- Um de
"sending_stream" streamstringObrigatório- Um de
"transactional""broadcast" statusstringObrigatóriopausedholds every new message on the lane until it is resumed. Only the broadcast lane pauses.Um de"active""paused"pausedAtstringObrigatório- Pode ser nullFormato
date-time pausedReasonstringObrigatórioWhich limit was passed, or null on an active lane.
Pode ser nullUm de"bounce_rate""complaint_rate"resumedAtstringObrigatórioWhen the lane was last resumed. The count in
windowstarts no earlier than this.Pode ser nullFormatodate-timewindowobjectObrigatóriosincestringObrigatório- Formato
date-time untilstringObrigatório- Formato
date-time recipientsintegerObrigatórioRecipients the lane handed over for delivery in the window.
bouncedintegerObrigatóriocomplainedintegerObrigatórioRecipients who reported the mail as spam.
bounceRatenumberObrigatórioBounced over recipients, from 0 to 1.
complaintRatenumberObrigatórioComplained over recipients, from 0 to 1.
limitsobjectObrigatóriobounceRatenumberObrigatórioThe broadcast lane pauses above this bounce rate.
complaintRatenumberObrigatórioThe broadcast lane pauses above this complaint rate.
minimumRecipientsintegerObrigatórioThe rates are only judged once the lane reached this many recipients in the window.
windowDaysintegerObrigatório
SendingStreamListobject
objectstringObrigatório- Um de
"list" dataSendingStream[]Obrigatório