Suspend all subscriptions

Description

Changes profile subscription status from "subscribed" to "suspended".

Does not affect any other subscription status.

Request URL

Method: POST

https://example.com/api/v1.1/subscriptions/suspend_all

Request example

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json.
db_id	int	1	Yes	Database ID
channel	int	"email"	No	Channel type
resource_id	int	1	No	Resource ID

If "channel" parameter is specified, all channel subscriptions for a database will be suspended.

If "resource_id" parameter is specified, all resource subscriptions for a database will be suspended.

If both parameters are specified - resource and channel subscriptions will be suspended.

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "db_id": 1,
    "channel": "email"   
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <db_id>1</db_id>
  <channel>email</channel>
</xml>

Response example

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "updated": 4080
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <updated>1344</updated>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
updated	int	Number of subscriptions suspended