Email
POST a single email message
Represents a single email message that will be converted to a single Global Relay EML
post/v2/email
Request
- Base URLhttps://swaggerhub.globalrelay.net/virts/Gateway-APIs/oc-email-api/1.2
- AuthOAuth 2Client credentials
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
X-SubTypestring required
Request body
Example request
{
"requestInfo": {
"requestId": "c1319852-5367-5958-9aee-98fffdc22490"
},
"emailOverview": {
"messageId": "c1319852-5367-5958-9aee-98fffdc22491",
"time": 1672531200000,
"subject": "RE Compliance Archiving Tools",
"senders": [
{
"displayName": "Joe Bloggs",
"companyName": "Corp Company",
"accountId": "123456",
"accountName": "Bloomberg/ 404 MyCompany",
"primaryEmail": "joe@example.com",
"otherAlias": "userJoeBloggs1234",
"identityType": "internal",
"phoneNumber": "00 44 1234 567890",
"senderType": "sender"
}
],
"recipients": [
{
"deliveryTypes": [
"to",
"cc"
],
"displayName": "Joe Bloggs",
"companyName": "Corp Company",
"accountId": "123456",
"accountName": "Bloomberg/ 404 MyCompany",
"primaryEmail": "joe@example.com",
"otherAlias": "userJoeBloggs1234",
"phoneNumber": "00 44 1234 567890",
"identityType": "internal"
}
],
"content": {
"textType": "plain",
"priority": "high",
"sensitivity": "internal",
"classification": "marketing",
"signature": "Joe Bloggs Employee My Company",
"disclaimer": "This message is intended only for the use of the individual or entity to which it is addressed."
},
"files": [
{
"filename": "meeting-video.mp4",
"fileKey": "example-corp/all-meetings/meeting-video.mp4"
},
{
"filename": "image.gif",
"fileKey": "default/acmeLtd/12345",
"fileHref": "https://giphy.com/gifs/JIX9t2j0ZTN9S"
},
{
"filename": "attached-image.jpg",
"fileKey": "default/acmeLtd/123456",
"contentId": "c1319852"
}
],
"eventType": "email_sent"
}
}Response
Successful Operation
Example response
{
"reconciliationId": "c1319852-5367-5958-9aee-98fffdc22493"
}Changes
No recorded changes to this operation across all 1 revision of this API.