Back to PipedriveGet all mail messages of mail thread
Returns all the mail messages inside a specified mail thread.
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: integer
description: The ID of the mail thread
required:
- id
Output
title: getAllMailMessagesOfMailThreadResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: array
description: The array of the mail messages of the mail thread
items:
type: object
properties:
id:
type: integer
description: ID of the mail thread
account_id:
type: string
description: The connection account ID
user_id:
type: integer
description: ID of the user whom mail message will be assigned to
subject:
type: string
description: The subject
snippet:
type: string
description: A snippet
read_flag:
description: Whether the mail thread is read
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
mail_tracking_status:
type: string
nullable: true
description: Mail tracking status
has_attachments_flag:
description: Whether the mail thread has an attachment
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
has_inline_attachments_flag:
description: Whether the mail thread has inline attachments
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
has_real_attachments_flag:
description: Whether the mail thread has real attachments (which are not inline)
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
deleted_flag:
description: Whether the mail thread is deleted
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
synced_flag:
description: Whether the mail thread is synced
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
smart_bcc_flag:
description: Whether one of the parties of the mail thread is Bcc
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
mail_link_tracking_enabled_flag:
description: Whether the link tracking of the mail thread is enabled
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
from:
type: array
description: Senders of the mail thread
items:
type: object
description: Member of a thread
properties:
id:
type: integer
description: ID of the mail thread participant
name:
type: string
description: Name of the mail thread participant
latest_sent:
type: boolean
description: Whether the mail thread participant was last to send an email
email_address:
type: string
description: Email address of the mail thread participant
message_time:
type: number
description: Message time
linked_person_id:
type: integer
description: ID of the linked person
linked_person_name:
type: string
description: Email of the linked person
mail_message_party_id:
type: integer
description: ID of the mail message party
linked_organization_id:
type: integer
nullable: true
description: Linked Organization ID
to:
type: array
description: Recipients of the mail thread
items:
type: object
description: Member of a thread
properties:
id:
type: integer
description: ID of the mail thread participant
name:
type: string
description: Name of the mail thread participant
latest_sent:
type: boolean
description: Whether the mail thread participant was last to send an email
email_address:
type: string
description: Email address of the mail thread participant
message_time:
type: number
description: Message time
linked_person_id:
type: integer
description: ID of the linked person
linked_person_name:
type: string
description: Email of the linked person
mail_message_party_id:
type: integer
description: ID of the mail message party
linked_organization_id:
type: integer
nullable: true
description: Linked Organization ID
cc:
type: array
description: Participants of the Cc
items:
type: object
description: Member of a thread
properties:
id:
type: integer
description: ID of the mail thread participant
name:
type: string
description: Name of the mail thread participant
latest_sent:
type: boolean
description: Whether the mail thread participant was last to send an email
email_address:
type: string
description: Email address of the mail thread participant
message_time:
type: number
description: Message time
linked_person_id:
type: integer
description: ID of the linked person
linked_person_name:
type: string
description: Email of the linked person
mail_message_party_id:
type: integer
description: ID of the mail message party
linked_organization_id:
type: integer
nullable: true
description: Linked Organization ID
bcc:
type: array
description: Participants of the Bcc
items:
type: object
description: Member of a thread
properties:
id:
type: integer
description: ID of the mail thread participant
name:
type: string
description: Name of the mail thread participant
latest_sent:
type: boolean
description: Whether the mail thread participant was last to send an email
email_address:
type: string
description: Email address of the mail thread participant
message_time:
type: number
description: Message time
linked_person_id:
type: integer
description: ID of the linked person
linked_person_name:
type: string
description: Email of the linked person
mail_message_party_id:
type: integer
description: ID of the mail message party
linked_organization_id:
type: integer
nullable: true
description: Linked Organization ID
body_url:
type: string
description: A link to the mail thread message
mail_thread_id:
type: integer
description: ID of the mail thread
draft:
type: string
nullable: true
description: >-
If the mail message has a draft status then the value is the mail
message object as JSON formatted string, otherwise `null`.
has_body_flag:
type: number
description: Whether the mail thread message has a body
title: numberBooleanDefault0
default: 0
enum:
- 0
- 1
sent_flag:
type: number
description: Whether the mail thread message is sent
title: numberBooleanDefault0
default: 0
enum:
- 0
- 1
sent_from_pipedrive_flag:
type: number
description: Whether the mail thread message is sent from Pipedrive
title: numberBooleanDefault0
default: 0
enum:
- 0
- 1
message_time:
type: string
format: date-time
description: The time when the mail message was received or created
add_time:
type: string
format: date-time
description: The time when the mail message was inserted to database
update_time:
type: string
format: date-time
description: The time when the mail message was updated in database received