KB Newsman
Newsman API Listing
Subscriber | |||
| API Method | HTTP method | Endpoint | Description |
|---|---|---|---|
| subscriber.get | GET | /subscriber.get.json | Returns subscriber data as hash (struct) array |
| subscriber.getByEmail | GET | /subscriber.getByEmail.json | Returns subscriber data as hash (struct) array |
| subscriber.history | GET | /subscriber.history.json | Returns subscriber action history (last 100 actions) as struct (array with history entries) |
| subscriber.update | POST | /subscriber.update.json | Updates email, firstname or lastname for a subscriber |
| subscriber.updateProps | POST | /subscriber.updateProps.json | Updates the properties of a subscriber |
| subscriber.addTag | POST | /subscriber.addTag.json | Adds a tag to a subscriber |
| subscriber.addTags | POST | /subscriber.addTags.json | Adds tags to a subscriber |
| subscriber.removeTag | POST | /subscriber.removeTag.json | Removes a tag from a subscriber |
| subscriber.removeTags | POST | /subscriber.removeTags.json | Updates the properties of a subscriber |
| subscriber.getSubscribersBatch | GET | /subscriber.getSubscribersBatch.json | Retrieves multiple subscribers by email or subscriber_id |
| subscriber.updatePropsBatch | POST | /subscriber.updatePropsBatch.json | Updates the properties of an array of subscribers |
| subscriber.updateProp | POST | /subscriber.updateProp.json | Updates one property of a subscriber |
| subscriber.addToSegment | POST | /subscriber.addToSegment.json | Adds a subscriber to the segment |
| subscriber.removeFromSegment | POST | /subscriber.removeFromSegment.json | Removes a subscriber from a segment |
| subscriber.saveSubscribe | POST | /subscriber.saveSubscribe.json | Saves / subscribes a subscriber to the list |
| subscriber.initSubscribe | POST | /subscriber.initSubscribe.json | Inits a confirmed opt in subscribe. Email is sent first to the subscriber with an unique link which has to be clicked. |
| subscriber.saveUnsubscribe | POST | /subscriber.saveUnsubscribe.json | Unsubscribes an email from a list |
| subscriber.saveUnsubscribeById | POST | /subscriber.saveUnsubscribe.json | Unsubscribes an abonat from a list |
| subscriber.initUnsubscribe | POST | /subscriber.initUnsubscribe.json | Inits an unsubscribe request. An email with an unsubscribe confirmation link is sent to the subscriber |
| subscriber.getProfilingAllowed | GET | /subscriber.getProfilingAllowed.json | Returns Gets if profiling is allowed or not for a subscriber |
| subscriber.setProfilingAllowed | POST | /subscriber.setProfilingAllowed.json | Sets if profiling is allowed or not for a subscriber |
| subscriber.search | GET | /subscriber.search.json | Returns the subscribers matching keywords, status and since (optional) for a list. |
| subscriber.anonymiseId | POST | /subscriber.anonymiseId.json | Anonymises a subscriber (by id) from a list |
| subscriber.anonymiseEmail | POST | /subscriber.anonymiseEmail.json | Anonymises a subscriber (by email) from a list |