Add newsletter subscribers

Adds one or more newsletter subscribers (by email) to the your community . Emails that already exist for that community are not inserted again.

HTTP Method

POST

Endpoint

/api/v1/global/newsletter/subscriber

Headers

Name	Type	Required	Description
x-api-key	String	✅ Yes	API key provided by the Networked Team (external vendor key scoped to your community).
Content-Type	String	✅ Yes	`application/json`

Body (`application/json`)

Name	Type	Required	Description
emails	String[]	✅ Yes	List of email addresses to register as subscribers.
subscriberList	String[]	❌ No	Subscriber list IDs to attach to each new subscriber (same lists applied to all emails in this request).

Sample Request Body

{
  "emails": [
    "subscriber1@example.com",
    "subscriber2@example.com"
  ],
  "subscriberList": []
}

Sample Response

{
  "data": {},
  "error": false,
  "message": "Operation completed successfully"
}

TypeScript

interface SubscriberAddRequest {
  emails: string[];
  subscriberList?: string[];
}

Reference

🔗 Standard Response Codes

Notes

This API must be used with a valid x-api-key authorized for your community.

Invalid emails fail validation; existing emails in the community are filtered out before insert.

curl --location 'https://backend.networked.co/api/v1/global/newsletter/subscriber' \ --header 'x-api-key: <your-api-key>' \ --header 'Content-Type: application/json' \ --data-raw '{ "emails": [ "subscriber23@yopmail.com" ], "subscriberList": [] }'