@linkpane/newsletter-subscribe 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,6 @@ npm install @linkpane/newsletter-subscribe
|
|
|
17
17
|
import { subscribeNewsletter } from '@linkpane/newsletter-subscribe'
|
|
18
18
|
|
|
19
19
|
const result = await subscribeNewsletter({
|
|
20
|
-
apiBaseUrl: 'https://api.linkpane.com',
|
|
21
20
|
username: 'my-newsletter',
|
|
22
21
|
data: {
|
|
23
22
|
email: 'subscriber@example.com',
|
|
@@ -34,13 +33,11 @@ if (!result.ok) {
|
|
|
34
33
|
## Notes
|
|
35
34
|
|
|
36
35
|
### Required Fields
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
- `email`
|
|
36
|
+
- **email**: The subscriber's email address.
|
|
37
|
+
- **firstName**: The subscriber's first name.
|
|
40
38
|
|
|
41
|
-
|
|
42
|
-
-
|
|
43
|
-
- `lastName`
|
|
39
|
+
### Optional Fields
|
|
40
|
+
- **lastName**: The subscriber's last name.
|
|
44
41
|
|
|
45
42
|
### Origin Rules
|
|
46
43
|
For browser usage, ensure the request Origin matches the configured source domain.
|