active_campaign v0.2.5

View Source ActiveCampaign.Deal (active_campaign v0.2.5)

Documentation for ActiveCampaign.Deal.

Link to this section Summary

Functions

bulk(deals)

Bulk Update Deal Owners

create(deal)

Create a deal

create_note(id, note)

Create a deal note

delete(id)

Delete a deal

get(id)

Retrieve a deal

list(query)

List all deals

update(id, deal)

Update a deal

update_note(id, note_id, note)

Update a deal note

Link to this section Functions

Link to this function

bulk(deals)

View Source 
@spec bulk([map()]) :: {:ok, map()} | {:error, any()}

Bulk Update Deal Owners

examples

 Examples 

iex> ActiveCampaign.Deal.bulk()
{:ok, %{...}}
Link to this function

create(deal)

View Source 
@spec create(map()) :: {:ok, map()} | {:error, any()}

Create a deal

examples

 Examples 

iex> ActiveCampaign.Deal.create(%{contact: "51", ...})
{:ok, %{...}}
Link to this function

create_note(id, note)

View Source 
@spec create_note(integer(), map()) :: {:ok, map()} | {:error, any()}

Create a deal note

examples

 Examples 

iex> ActiveCampaign.Deal.create_note(123, %{note: "Note for the deal"})
{:ok, %{...}}
Link to this function

delete(id)

View Source 
@spec delete(integer()) :: {:ok, map()} | {:error, any()}

Delete a deal

examples

 Examples 

iex> ActiveCampaign.Deal.delete(123)
{:ok, %{...}}
Link to this function

get(id)

View Source 
@spec get(integer()) :: {:ok, map()} | {:error, any()}

Retrieve a deal

examples

 Examples 

iex> ActiveCampaign.Deal.get(123)
{:ok, %{"owner" => "1", ...}}
Link to this function

list(query)

View Source 
@spec list(map()) :: {:ok, map()} | {:error, any()}

List all deals

examples

 Examples 

iex> ActiveCampaign.Deal.list()
{:ok, %{...}}
Link to this function

update(id, deal)

View Source 
@spec update(integer(), map()) :: {:ok, map()} | {:error, any()}

Update a deal

examples

 Examples 

iex> ActiveCampaign.Deal.update(123, %{contact: "51", ...})
{:ok, %{...}}
Link to this function

update_note(id, note_id, note)

View Source 
@spec update_note(integer(), integer(), map()) :: {:ok, map()} | {:error, any()}

Update a deal note

examples

 Examples 

iex> ActiveCampaign.Deal.update_note(123, %{note: "Update with more info"})
{:ok, %{...}}