SUsurense
App Mail Records

Fetch email records by ID

Returns the search view of the given email records that belong to the given parent entity, after checking the caller can access that entity. Used by the activity journal.

post/appmail/fetch

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/appmail/fetch
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Request body

employerIdstring uuid

Parent employer ID. Cannot be combined with customerId, leadId or workflowId.

customerIdstring uuid

Parent customer ID. Cannot be combined with leadId or workflowId.

leadIdstring uuid

Parent lead ID. Cannot be combined with workflowId.

workflowIdstring uuid

Parent workflow ID.

meetingIdstring uuid

Parent meeting ID; used only when no other parent ID is given.

idsstring[]

Email record IDs to fetch; must not be empty.

Example request

{
  "employerId": "0d7e3a92-1f4b-4c8e-b6a5-9e2c7f1d4b38",
  "customerId": "3f2b8c1e-6d4a-4b7e-9a51-2c8e7f0d1a93",
  "leadId": "7c5a1e3b-9d2f-4a68-8b0e-4f6d2a9c1e57",
  "workflowId": "e2b9f4d6-3a1c-4e75-9f08-6b4d1c7a3e92",
  "meetingId": "4a8c2e6f-0b3d-4f19-a7c5-2e9b6d0f4a31"
}

Response

OK

idstring uuid
providerstring
versioninteger
subjectstring
plainContentstring
tenantIdstring uuid
leadIdstring uuid
customerIdstring uuid
employerIdstring uuid
workflowIdstring uuid
meetingIdstring uuid
fromAddressstring
createdBystring uuid
fromPersonalstring
emlSizeinteger
htmlSizeinteger
providerMessageIdstring
providerWebLinkstring
createdDatestring date-time
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.