View Source ActiveCampaign.Note (active_campaign v0.2.3)

Documentation for ActiveCampaign.Note.

Link to this section Summary

Functions

Create a note

Delete a note

Retrieve a note

Update a note

Link to this section Functions

@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" => %{...}}}
@spec delete(integer()) :: {:ok, map()} | {:error, any()}

Delete a note

examples

Examples

iex> ActiveCampaign.Note.delete(1)
{:ok, %{...}}
@spec get(integer()) :: {:ok, map()} | {:error, any()}

Retrieve a note

examples

Examples

iex> ActiveCampaign.Note.get(1)
{:ok, %{"note" => %{...}}}
@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" => %{...}}}