Email Insights
Required scopes
This endpoint requires the following scopes:
- : Access to the public API
Authorizations
OAuth2clientCredentialsRequiredToken URL:
OAuth2 client credentials flow for API access
Body
Input model for email insights extraction.
email_bodiesstring[]RequiredExample:
The body text of the email to analyze for insights.
["Hi Sarah,\n\nThanks for your email about the Q2 sales projections. I've reviewed the numbers and they look promising.\n\nJust a heads up - I'll be traveling for a conference from June 10th through June 14th, so my response times might be a bit slower than usual. You can still reach me on my mobile (555) 123-4567, or if it's urgent, feel free to call the office at (555) 123-0000 and ask for my assistant.\n\nLet's schedule a follow-up call when I'm back to discuss the next steps.\n\nBest regards,\nJohn\n\n--\nJohn Doe\nSenior Account Manager | Sales Department\nAcme Corporation\n123 Main St, Springfield, USA\nMobile: (555) 123-4567 | Office: (555) 123-0000\n\nLinkedIn: https://linkedin.com/in/johndoe\nTwitter: https://twitter.com/johndoe\n\nFollow us:\nLinkedIn: https://linkedin.com/company/acmecorp\nFacebook: https://facebook.com/acmecorporation"]Responses
200
Email insights extracted successfully for 2 emails.
application/json
Output model for extracted email insights.
resultsany ofOptionalExample:
The extracted insights from the emails if successful, otherwise None.
[{"address":"123 Main St, Springfield, USA","company":"Acme Corporation","confidence":0.95,"department":"Sales","mobile":"+15551234567","name":"John Doe","out_of_office":{"end_date":"2024-06-14","start_date":"2024-06-10","status":true},"phone":"+15551230000","social_media":[{"name":"LinkedIn","owner":"sender","url":"https://linkedin.com/in/johndoe"}],"title":"Senior Account Manager"}]or
nullOptional
messagestringRequiredExample:
The message to return to the user.
Email insights extracted successfully for 2 emails.statusstring · enumRequiredExample:
The status of the process
SUCCESSPossible values: status_codeintegerRequiredExample:
The status code to return to the user.
200400
Invalid email body provided.
application/json
401
Authentication failed - invalid or missing OAuth 2.0 token
application/json
500
Failed to extract insights from emails.
application/json
post
/v1/email-insightsLast updated
Was this helpful?