Mailbox
Mailbox was designed to be the email control hub inside Pipedrive. Pipedrive supports all major providers (including Gmail, Outlook and also custom IMAP/SMTP). There are 2 options for syncing user emails: 2-way sync: Mail Connection is established with the mail provider (example Gmail). There can be only 1 active Mail Connection per user in company. 1-way sync: SmartBCC feature which stores the copies of email messages to Pipedrive by adding the SmartBCC specific address to mail recipients.
Get one mail message
Returns data about a specific mail message.
Request
/v1/mailbox/mailMessages/{id}
Path parameters
id
integer
required
The ID of the mail message to fetch
Query parameters
include_body
number
Whether to include the full message body or not. 0 = Don't include, 1 = Include.
Default
0
Values
0
1
Response
OK
Expand all
Copy code- true
- 2000
- "Success"
- "email-api"
- { ... }▶
Get mail threads
Returns mail threads in a specified folder ordered by the most recent message within.
Request
/v1/mailbox/mailThreads
Query parameters
folder
string
required
The type of folder to fetch
Default
inbox
Values
inbox
drafts
sent
archive
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
Response
OK
Expand allCopy code- true
- [ ... ]▶
Get one mail thread
Returns a specific mail thread.
Request
/v1/mailbox/mailThreads/{id}
Path parameters
id
integer
required
The ID of the mail thread
Response
OK
Expand allCopy code- true
- { ... }▶
Get all mail messages of mail thread
Returns all the mail messages inside a specified mail thread.
Request
/v1/mailbox/mailThreads/{id}/mailMessages
Path parameters
id
integer
required
The ID of the mail thread
Response
OK
Expand allCopy code- true
- [ ... ]▶
Update mail thread details
Updates the properties of a mail thread.
Request
/v1/mailbox/mailThreads/{id}
Path parameters
id
integer
required
The ID of the mail thread
Body parameters
application/x-www-form-urlencoded
deal_id
integer
The ID of the deal this thread is associated with
lead_id
string
The ID of the lead this thread is associated with
Format
uuid
shared_flag
Whether this thread is shared with other users in your company
Values
0
1
read_flag
Whether this thread is read or unread
Values
0
1
archived_flag
Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox.
Values
0
1
Response
OK
Expand allCopy code- true
- { ... }▶
Delete mail thread
Marks a mail thread as deleted.
Request
/v1/mailbox/mailThreads/{id}
Path parameters
id
integer
required
The ID of the mail thread
Response
OK
Expand allCopy code- true
- 2000
- "Success"
- "email-api"
- { ... }▶