KB Newsman
Newsman Api Method: subscriber.initUnsubscribe
Prototype: subscriber.initUnsubscribe(list_id, email, options)
Description: Inits an unsubscribe request. An email with an unsubscribe confirmation link is sent to the subscriber
HTTP method: POST
Endpoint HTTP: /subscriber.initUnsubscribe.json
Endpoint XML-RPC: subscriber.initUnsubscribe
Return type: string|intReturn info: The subscriber id
Request parameters POST
| Variable | Type | Description |
|---|---|---|
| list_id | string|int | The ID of the list from which to unsubscribe |
| string | The email of the subscriber | |
| options | struct|null | Hash array with options for this unsubscribe init request. Valid keys are:
|
Response parameters
| Parameter | Description |
|---|---|
| int | The subscriber id |
Output example
"75002"Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param list_id | list_id param is required |
| 407 | Missing required param email | email param is required |
| 407 | Missing required param options | options param is required |
| 101 | Not allowed for list_id = %s | Invalid access to subscriber list_id |
| 108 | List %s has been deleted | List ID belongs to a list which has been deleted |
| 121 | No such email found | The email was not found |
| 126 | This email is not active | Cannot send unsubscribe request to this email |
| 201 | Internal ERROR. | A database error occurred |
Error examples
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Missing required param email", "code": 407 }
{ "err": true, "message": "Missing required param options", "code": 407 }