When you are implementing Subscription Management, use this method to unsubscribe users from a mailing list or newsletter subscription with a one-click unsubscribe.
Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.
If you are not sure of your site's data center, see Finding Your Data Center.Request URL
us1.gigya.com
- For the US data center.eu1
- For the European data center..gigya.com
au1
- For the Australian data center..gigya.com
ru1
- For the Russian data center..gigya.com
cn1
- For the Chinese data center..gigya-api.cn
Parameters
Required | Name | Type | Description | ||||||||||||||||||||
| subscriptionID | string | The name of the newsletter from which the user is being unsubscribed. | ||||||||||||||||||||
| string | The email to unsubscribe from this newsletter. You must provide either the email or the channelToken property. | |||||||||||||||||||||
| channelToken | string | The token returned from accounts.search of the emailAccounts for the user. This is used when unsubscribing via a 3rd party, so not to expose the user's PII email address. You must provide either the email or the channelToken property. | ||||||||||||||||||||
| tags | Array of strings | Any tags you want to associate with the subscription change. Note that this will overwrite any previous tags associated with the subscription. If passed empty, all previously existing tags will be removed. | ||||||||||||||||||||
|
Authorization Parameters
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:
- accounts.login
- socialize.login
- accounts.notifyLogin
- socialize.notifyLogin
- accounts.finalizeRegistration
- accounts.linkAccounts
Please refer to the Authorization Parameters section for details.
Sample Requests
Response Data
Field | Type | Description | ||||||||||||||||||||||||
|
Response Example
{ "statusCode": 200, "errorCode": 0, "statusReason": "OK", "callId": "d283b155fcbc4c48836f29c4e87e77a8", "time": "2015-03-22T11:42:25.943Z" }
Additional Information