View Source ActiveCampaign.User (active_campaign v0.2.3)

Documentation for ActiveCampaign.User.

Link to this section Summary

Functions

Create a user

Delete a user

Retrieve a user

Retrieve a user by email

Retrieve a user by username

List all users

Retrieve logged-in user

Update a user

Link to this section Functions

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

Create a user

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

Delete a user

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

Retrieve a user

@spec get_by_email(String.t()) :: {:ok, map()} | {:error, any()}

Retrieve a user by email

Link to this function

get_by_username(username)

View Source
@spec get_by_username(String.t()) :: {:ok, map()} | {:error, any()}

Retrieve a user by username

Link to this function

list(query_params \\ %{})

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

List all users

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

Retrieve logged-in user

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

Update a user