Remetentes
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Parâmetros de caminho
emailstringObrigatórioAn address of the sender, such as
[email protected]. Only its domain is read.
Devolve
What is known about the sender.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
emailstringObrigatórioAn address of the sender, such as
[email protected]. Only its domain is read.
Devolve
What was found.
Erros
- 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.
Os erros que qualquer operação pode devolver400401403422500Catálogo de erros
Também disponível em
Objetos
SenderProfileobject
objectstringObrigatório- Um de
"sender_profile" domainstringObrigatórioThe domain that was looked up.
aboutstringObrigatórioA sentence or two in plain prose about the organisation behind it.
Até 400 caracteresupdatedAtstringObrigatório- Formato
date-time