BentoSdk.Subscribers (BentoSDK v0.1.0)
View SourceFunctions for managing subscribers in Bento.
Summary
Functions
Add a field to a subscriber.
Add a tag to a subscriber.
Add a tag to a subscriber via an event.
Change a subscriber's email.
Create a subscriber with the given email.
Find a subscriber by email.
Find a subscriber by email, or create one if it doesn't exist.
Remove a field from a subscriber.
Remove a tag from a subscriber.
Subscribe a user.
Unsubscribe a user.
Update a subscriber with the given attributes.
Functions
Add a field to a subscriber.
Examples
BentoSdk.Subscribers.add_field("user@example.com", "company", "Acme Inc.")
{:ok, %{
"success" => true
}}
Add a tag to a subscriber.
Examples
BentoSdk.Subscribers.add_tag("user@example.com", "vip")
{:ok, %{
"success" => true
}}
Add a tag to a subscriber via an event.
Examples
BentoSdk.Subscribers.add_tag_via_event("user@example.com", "vip")
{:ok, %{
"success" => true
}}
Change a subscriber's email.
Examples
BentoSdk.Subscribers.change_email("old@example.com", "new@example.com")
{:ok, %{
"success" => true
}}
Create a subscriber with the given email.
Examples
BentoSdk.Subscribers.create("user@example.com")
{:ok, %{
"email" => "user@example.com"
}}
Find a subscriber by email.
Examples
BentoSdk.Subscribers.find("user@example.com")
{:ok, %{
"email" => "user@example.com",
"first_name" => "John",
"last_name" => "Doe"
}}
BentoSdk.Subscribers.find("nonexistent@example.com")
{:ok, nil}
Find a subscriber by email, or create one if it doesn't exist.
Examples
BentoSdk.Subscribers.find_or_create("user@example.com")
{:ok, %{
"email" => "user@example.com"
}}
Remove a field from a subscriber.
Examples
BentoSdk.Subscribers.remove_field("user@example.com", "company")
{:ok, %{
"success" => true
}}
Remove a tag from a subscriber.
Examples
BentoSdk.Subscribers.remove_tag("user@example.com", "vip")
{:ok, %{
"success" => true
}}
Subscribe a user.
Examples
BentoSdk.Subscribers.subscribe("user@example.com")
{:ok, %{
"success" => true
}}
Unsubscribe a user.
Examples
BentoSdk.Subscribers.unsubscribe("user@example.com")
{:ok, %{
"success" => true
}}
Update a subscriber with the given attributes.
This uses the Import Subscribers endpoint to update a single subscriber.
Examples
BentoSdk.Subscribers.update("user@example.com", %{first_name: "John", last_name: "Doe"})
{:ok, %{
"imported" => 1,
"errors" => []
}}