Alta API Documentation

An email message is an individual email sent or received. Each message has a sender, recipients, subject, body, and metadata about its type and status.

Fields

string (uuid)

required

Unique identifier for the email message.

string

required

Always email_message.

string (uuid)

The ID of the email thread this message belongs to.

string

required

The email subject line.

string

required

The email body content.

ContactInfo | null

The sender of the email. See ContactInfo below.

string

The type of the email message. One of manual, campaign, reply_agent, or received.

string

The status of the email message. One of sent or draft.

string (uuid)

The ID of the prospect associated with this message.

string (uuid)

The ID of the rep associated with this message.

object

required

The email recipients, broken down by type.

Show recipients properties

ContactInfo[]

required

Primary recipients.

ContactInfo[]

CC recipients.

ContactInfo[]

BCC recipients.

string (date-time)

required

Timestamp when the email was sent.

string (date-time)

required

Timestamp when the email message record was created.

string (date-time)

required

Timestamp when the email message record was last updated.

ContactInfo

The contact info object is used for email senders and recipients.

string

required

Display name of the contact.

string

required

Email address of the contact.

Example

{
  "id": "e8f9a0b1-c2d3-4567-890a-bcdef1234567",
  "objectType": "email_message",
  "emailThreadId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "subject": "Quick follow-up on our conversation",
  "body": "Hi Jane, just wanted to follow up on our call last week...",
  "from": {
    "name": "Alex Johnson",
    "email": "alex@altahq.com"
  },
  "type": "manual",
  "status": "sent",
  "prospectId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "repId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "recipients": {
    "to": [
      {
        "name": "Jane Smith",
        "email": "jane.smith@acme.com"
      }
    ],
    "cc": [],
    "bcc": []
  },
  "sentAt": "2024-01-18T14:20:00Z",
  "createdAt": "2024-01-18T14:20:00Z",
  "updatedAt": "2024-01-18T14:20:00Z"
}

Used in

List email messages - returns an array of email message objects
Get an email message - returns a single email message object

Getting started

Endpoints

Objects & Definitions

Email message

Fields

ContactInfo

Example

Used in

​Fields

​ContactInfo

​Example

​Used in

Fields

ContactInfo

Example

Used in