View Source ExPipedrive.Persons (ex_pipedrive v0.1.0)

Pipedrive persons resource.

v2-first helpers (get/2, create/2, update/3, list_page/2, stream/2) talk to /api/v2/persons. Prefer ExPipedrive.Search.search_persons/3 (or search_v2/3 here) for v2 itemSearch. Legacy get_person/2, create_person/2, list_persons/2, and search_persons/3 remain on API v1.

Summary

Functions

create(client, attrs)

Creates a person via POST /api/v2/persons.

create_person(client, person)

get(client, person_id)

Fetches a person by id via GET /api/v2/persons/:id.

get_person(client, id)

list_page(client, opts \\ [])

list_persons(client, opts \\ [])

list_persons_page(client, opts \\ [])

search_persons(client, term, opts \\ [])

search_v2(client, term, opts \\ [])

Searches persons via API v2 itemSearch. See ExPipedrive.Search.search_persons/3.

stream(client, opts \\ [])

stream_persons(client, opts \\ [])

update(client, person_id, attrs)

Updates a person via PATCH /api/v2/persons/:id.

Functions

create(client, attrs)

Creates a person via POST /api/v2/persons.

Accepts a map (preferred) or %Person{}. For v2, email/phone values belong under emails / phones lists.

create_person(client, person)

get(client, person_id)

Fetches a person by id via GET /api/v2/persons/:id.

get_person(client, id)

list_page(client, opts \\ [])

list_persons(client, opts \\ [])

list_persons_page(client, opts \\ [])

search_persons(client, term, opts \\ [])

search_v2(client, term, opts \\ [])

Searches persons via API v2 itemSearch. See ExPipedrive.Search.search_persons/3.

stream(client, opts \\ [])

stream_persons(client, opts \\ [])

update(client, person_id, attrs)

Updates a person via PATCH /api/v2/persons/:id.