Sha256: 47439febb3ccff1600f7dfbcc6b2e44d018ac17633ab2ef96d3e329d381e8b3d

Contents?: true

Size: 1.05 KB

Versions: 5

Compression:

Stored size: 1.05 KB

Contents

# Subscribers

## Get single subscriber

```ruby
client.subscriber(subscriber_id)
```

or with email

```ruby
client.subscriber('user@example.com')
```

## Update single subscriber

```ruby
client.update_subscriber(subscriber_id options)
```

or with email

```ruby
client.update_subscriber('user@example.com', options)
```

`options` can be:

- `fields` [Array]: Associated array where key is the same as field key.
- `type` [String]: Available values: `unsubscribed`, `active`
- `resend_autoresponders` [Boolean]: Defines if it is needed to resend autoresponders

## Search for subscribers

```ruby
options = {
  query: 'example',
  limit: 1,
  minimized: true
}

client.search_subscribers(query, options)
```

## Get groups subscriber belongs to

```ruby
client.subscriber_groups(subscriber_id)
```

or with email

```ruby
client.subscriber_groups('user@example.com')
```

## Get activites (clicks, opens, etc.) of selected subscriber
```ruby
client.subscriber_activities(subscriber_id)
```

or with email

```ruby
client.subscriber_activities('user@example.com')
```

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
mailerlite-1.5.0 examples/subscribers.md
mailerlite-1.4.0 examples/subscribers.md
mailerlite-1.3.0 examples/subscribers.md
mailerlite-1.2.0 examples/subscribers.md
mailerlite-1.1.0 examples/subscribers.md