Rpipedrive (version 0.1.1)

mailthreads.update: Update mail thread details

Description

Function to Update mail thread details on pipedrive.

Usage

mailthreads.update(id, deal_id = NULL, shared_flag = NULL,
  read_flag = NULL, archived_flag = NULL, api_token = NULL,
  company_domain = "api", return_type = c("complete", "boolean"))

Arguments

id

ID of the mail thread

deal_id

ID of the deal this thread is associated with

shared_flag

Whether this thread is shared with other users in your company This field has the following domains: (0; 1)

read_flag

Whether this thread read or unread This field has the following domains: (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. This field has the following domains: (0; 1)

api_token

To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference>

company_domain

How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain>

return_type

the default return is an object List with all informations of process, or you can set boolean (TRUE = success, FALSE = error)

Value

customizable return, the default is an object List

Examples

# NOT RUN {
mailthreads.update(id='e.g.',api_token='token',company_domain='exp')
# }