latestOpenAPI 3.1.02026-08-233001841.3 MB
0dcf3303e9d7
activities.emails
Get a single Email activity
get/activity/email/{id}/
Path parameters
idstring required
Query parameters
_fieldsstring
Comma-separated list of fields to include in the response.
Response
Successful response
_typestring required
activity_atstring date-time nullable required
agent_action_reasonstring nullable
agent_config_idstring nullable
bccstring[] required
body_htmlstring nullable required
body_previewstring nullable
body_textstring nullable required
bulk_email_action_idstring nullable required
ccstring[] required
contact_idstring nullable required
created_bystring nullable required
created_by_namestring nullable
date_createdstring date-time required
date_scheduledstring date-time nullable required
date_sentstring date-time nullable required
date_updatedstring date-time required
direction'incoming' | 'outgoing' required
Direction of communication. Outgoing means the communication flowing from the user to the lead/contact. Inbound means the opposite.
email_account_idstring nullable
envelopeobject nullable
followup_sequence_add_cc_bccboolean required
followup_sequence_delayinteger nullable required
followup_sequence_idstring nullable
has_replyboolean required
idstring required
in_reply_to_idstring nullable required
lead_idstring nullable required
message_idsstring[] required
need_smtp_credentialsboolean required
opens_summarystring nullable required
organization_idstring required
referencesstring[] required
send_as_idstring nullable required
send_attemptsobject[] nullable
senderstring nullable required
sequence_idstring nullable
sequence_namestring nullable
sequence_subscription_idstring nullable
status'inbox' | 'draft' | 'scheduled' | 'outbox' | 'sent' | 'error' required
Status of a message, such as Email or SMS.
subjectstring nullable required
template_idstring nullable required
template_namestring nullable
thread_idstring nullable required
tostring[] required
updated_bystring nullable required
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required