Rpipedrive (version 0.1.1)

users.add.blacklistedemails: Add blacklisted email address for a user

Description

Function to Add blacklisted email address for a user on pipedrive.

Usage

users.add.blacklistedemails(id, address, api_token = NULL,
  company_domain = "api", return_type = c("complete", "boolean"))

Arguments

id

ID of the user

address

Email address to blacklist (can contain * for wildcards, e.g. *@example.com, or john*@ex*.com)

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 {
users.add.blacklistedemails(id='e.g.',address='e.g.',api_token='token',company_domain='exp')
# }