Skip to content

Commit 3ccc575

Browse files
other: Readme update
1 parent 1faada1 commit 3ccc575

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ The following service methods are available to instantiated clients. The example
111111
- [create](#create-2)
112112
- [Bounces Example](#bounces-example-2)
113113
- [Unsubscribes Example](#unsubscribes-example-2)
114+
- [Unsubscribe from one tag](#unsubscribe-from-one-tag)
114115
- [Unsubscribe from particular tags](#unsubscribe-from-particular-tags)
115116
- [Complaints Example](#complaints-example-2)
116117
- [destroy](#destroy-1)
@@ -1042,7 +1043,7 @@ Method naming conventions:
10421043

10431044
Promise returns:
10441045

1045-
```JSON
1046+
```js
10461047
{
10471048
message: "1 address has been added to the bounces table"
10481049
}
@@ -1051,7 +1052,7 @@ Method naming conventions:
10511052
- #### Unsubscribes Example:
10521053

10531054
```js
1054-
mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: '[email protected]'}])
1055+
mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: '[email protected]'})
10551056
.then(msg => console.log(msg)) // logs response data
10561057
.catch(err => console.error(err)); // logs any error
10571058
```
@@ -1072,7 +1073,19 @@ Method naming conventions:
10721073
message: "1 address has been added to the unsubscribes table"
10731074
}
10741075
```
1076+
- #### Unsubscribe from one tag
1077+
```js
1078+
mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: '[email protected]', tag: 'your_tag_to_unsubscribe']})
1079+
.then(msg => console.log(msg)) // logs response data
1080+
.catch(err => console.error(err)); // logs any error
1081+
```
1082+
Promise returns:
10751083

1084+
```JS
1085+
{
1086+
message: "1 address has been added to the unsubscribes table"
1087+
}
1088+
```
10761089
- #### Unsubscribe from particular tags
10771090
```js
10781091
mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: '[email protected]', tags: ['your_tag_to_unsubscribe', 'another_tag_to_unsubscribe']}])

dist/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ The following service methods are available to instantiated clients. The example
111111
- [create](#create-2)
112112
- [Bounces Example](#bounces-example-2)
113113
- [Unsubscribes Example](#unsubscribes-example-2)
114+
- [Unsubscribe from one tag](#unsubscribe-from-one-tag)
114115
- [Unsubscribe from particular tags](#unsubscribe-from-particular-tags)
115116
- [Complaints Example](#complaints-example-2)
116117
- [destroy](#destroy-1)
@@ -1042,7 +1043,7 @@ Method naming conventions:
10421043

10431044
Promise returns:
10441045

1045-
```JSON
1046+
```js
10461047
{
10471048
message: "1 address has been added to the bounces table"
10481049
}
@@ -1051,7 +1052,7 @@ Method naming conventions:
10511052
- #### Unsubscribes Example:
10521053

10531054
```js
1054-
mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: '[email protected]'}])
1055+
mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: '[email protected]'})
10551056
.then(msg => console.log(msg)) // logs response data
10561057
.catch(err => console.error(err)); // logs any error
10571058
```
@@ -1072,7 +1073,19 @@ Method naming conventions:
10721073
message: "1 address has been added to the unsubscribes table"
10731074
}
10741075
```
1076+
- #### Unsubscribe from one tag
1077+
```js
1078+
mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: '[email protected]', tag: 'your_tag_to_unsubscribe']})
1079+
.then(msg => console.log(msg)) // logs response data
1080+
.catch(err => console.error(err)); // logs any error
1081+
```
1082+
Promise returns:
10751083

1084+
```JS
1085+
{
1086+
message: "1 address has been added to the unsubscribes table"
1087+
}
1088+
```
10761089
- #### Unsubscribe from particular tags
10771090
```js
10781091
mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: '[email protected]', tags: ['your_tag_to_unsubscribe', 'another_tag_to_unsubscribe']}])

0 commit comments

Comments
 (0)