Absender
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
What is known about the organisation behind a sender: the line the reading pane shows under an unfamiliar sender, kept per domain for the whole workspace.
GET/senders/{email}
Read what is known about a sender
A sentence or two about the organisation behind the domain of the address, once it has been looked up. A domain nobody has looked up yet is a 404: POST /senders/{email}/research looks it up.
Requires the threads:read scope.
Pfadparameter
emailstringErforderlichAn address of the sender, such as
[email protected]. Only its domain is read.
Rückgabe
What is known about the sender.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/senders/{email}/research
Look a sender up
Searches the web for the organisation behind the domain of the address and keeps what it found for the whole workspace, as the reading pane does the first time it shows a sender. A domain that was looked up before is answered from what was kept, and nothing is searched again. Only the owner of the workspace may look senders up, with a key or an app that is not limited to particular addresses or domains, and a workspace looks up at most 200 a day.
Requires the threads:read scope.
Pfadparameter
emailstringErforderlichAn address of the sender, such as
[email protected]. Only its domain is read.
Rückgabe
What was found.
Fehler
- 404
Nothing could be found about the domain.
- 409
ai_not_configured: looking senders up is not available on this server.- 429
research_limit_reached: the workspace has looked up 200 senders today.
Die Fehler, die jede Operation zurückgeben kann400401403422500Fehlerkatalog
Auch verfügbar über
Objekte
SenderProfileobject
objectstringErforderlich- Einer von
"sender_profile" domainstringErforderlichThe domain that was looked up.
aboutstringErforderlichA sentence or two in plain prose about the organisation behind it.
Bis zu 400 ZeichenupdatedAtstringErforderlich- Format
date-time