active_campaign v0.3.0

View Source ActiveCampaign.Note (active_campaign v0.3.0)

Documentation for ActiveCampaign.Note.

Link to this section Summary

Functions

create(note)

Create a note

delete(id)

Delete a note

get(id)

Retrieve a note

update(id, note)

Update a note

Link to this section Functions

Link to this function

create(note)

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

Create a note

examples

 Examples 

iex> ActiveCampaign.Note.create(%{
  note: "This is the text of the note",
  relid: 2,
  reltype: "Subscriber"
})
{:ok, %{"note" => %{...}}}
Link to this function

delete(id)

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

Delete a note

examples

 Examples 

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

get(id)

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

Retrieve a note

examples

 Examples 

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

update(id, note)

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

Update a note

examples

 Examples 

iex> ActiveCampaign.Note.update(
  1,
  %{
    note: "This is the text of the note",
    relid: 2,
    reltype: "Subscriber"
  }
)
{:ok, %{"note" => %{...}}}