Sha256: 8984f0cf215e8af639718ce8b3d50eb9c43ed06dc8e324a2acc2103a6d7d62ce
Contents?: true
Size: 1.15 KB
Versions: 3
Compression:
Stored size: 1.15 KB
Contents
# Subscribers
## Get single subscriber
```ruby
client.subscriber(subscriber_id)
```
or with email
```ruby
client.subscriber('user@example.com')
```
## Create subscriber
```ruby
client.create_subscriber(email: 'john@example.com', name: 'John Smith')
```
## 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
3 entries across 3 versions & 1 rubygems
| Version | Path |
|---|---|
| mailerlite-1.7.0 | examples/subscribers.md |
| mailerlite-1.6.1 | examples/subscribers.md |
| mailerlite-1.6.0 | examples/subscribers.md |