AmoNotes: Notes

In grkhr/amocrm: AmoCRM API client

Description

Function to get notes.

Usage

AmoNotes(
  email = NULL,
  apikey = NULL,
  domain = NULL,
  auth_list = NULL,
  limit = 500,
  id = NULL,
  element_id = NULL,
  type = "contact",
  note_type = NULL,
  if_modified_since = NULL,
  all = F
)

Arguments

email	Email
apikey	Your api key from settings in interface
domain	Your domain in AmoCRM (xxx in xxx.amocrm.ru)
auth_list	List with auth data, you can build from AmoAuthList
limit	Batch limit, sometimes AmoCRM's API doesn't work properly, you can reduce the value and have a chance to load your data
id	Filter. Pass id or vector of ids of notes.
element_id	Filter. Id of lead/contact/etc. Vector is not allowed.
type	What to get. You can pass "contact", "lead", "company" or "task". Default to "contact". If you need all, look at "all" parameter.
note_type	Type of note. Useful filter. Check all note types.
if_modified_since	Filter. Get notes after some timestamp. Pass time like '2019-01-01 12:30:00'.
all	If you want to load all note for all types, set TRUE. You'll get list of dataframes.

Value

Dataframe in output (or list of dataframes if all = TRUE.)

References

Please READ this: Function documentation in Russian on GitHub

Also nice to read: AmoCRM official documentation

Examples

## Not run: 
# leads
notes <- AmoNotes(aiuth_list = auth_list, type = 'lead')

# get lead's statuses changes from 1 june 2019
notes <- AmoNotes(auth_list = auth_list, type = 'lead', note_type = 3, if_modified_since = '2019-06-01 00:00:00')

## End(Not run)

grkhr/amocrm documentation built on May 24, 2021, 5:24 a.m.