View Source ActiveCampaign.Contact.CustomField (active_campaign v0.2.3)

Documentation for ActiveCampaign.Contact.CustomField.

Link to this section Summary

Functions

Create a custom field

Bulk create custom field options

Create a custom field relationship to list(s)

Delete a custom field

Delete a custom field relationship to list(s)

Retrieve a custom field

List all custom fields

Update a custom field

Link to this section Functions

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

Create a custom field

Link to this function

create_field_options(field_options)

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

Bulk create custom field options

Link to this function

create_field_relationship(field_id, list_id)

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

Create a custom field relationship to list(s)

Setting list_id to 0 makes the field available on all lists.

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

Delete a custom field

Link to this function

delete_field_relationship(field_relationship_id)

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

Delete a custom field relationship to list(s)

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

Retrieve a custom field

examples

Examples

iex> ActiveCampaign.Contact.CustomField.get(1)
{:ok, %{"field" => %{...}}}
@spec list() :: {:ok, map()} | {:error, any()}

List all custom fields

examples

Examples

iex> ActiveCampaign.Branding.list()
{:ok, %{"fieldOptions" => [...], "fieldRels" => [...], "fields" => [...], "meta" => [...]}}
@spec update(integer(), map()) :: {:ok, map()} | {:error, any()}

Update a custom field