Conversations

Get conversation email

GET /api/v1/agents/{agentId}/conversations/{conversationId}/email

Get conversation email

Returns the inbound email for a conversation, including a signed URL for downloading the email message as an EML file.

Parameters

Name In Type Description
agentId * path integer

Internal agent id.

conversationId * path integer

Internal conversation id.

Responses

Status Schema Description
200 Email

Inbound email for the conversation

401 AgentError

Missing or invalid auth

403 AgentError

Caller cannot access this conversation email

Example 200 response
{
    "id": 1,
    "conversationId": 1,
    "fromEmail": "string",
    "fromName": "string",
    "toRecipients": "string",
    "ccRecipients": null,
    "bccRecipients": null,
    "subject": "string",
    "textBody": "string",
    "strippedTextReply": "string",
    "messageId": "string",
    "postmarkMessageId": "string",
    "replyTo": "string",
    "mailboxHash": "string",
    "originalRecipient": "string",
    "tag": "string",
    "messageStream": "string",
    "date": "string",
    "receivedAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "downloadUrl": "string"
}
Example 401 response
{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}
Example 403 response
{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}