Jump to: GET Response Notes | API Call Builder
Generates a Mail Room unsubscribe link for the specified mailing list and user.
When the user clicks on the link it will take them to the application
and cause their preference to be updated.
Affiliates, Advertisers, and Employees can unsubscribe from the three
mail-room related mailing lists:
disable_company_news_email (deprecated, but still unsubscribable); disable_offer_updates_email (deprecated, but still unsubscribable); disable_mail_room_email (replaces above two).
Employees can additionally unsubscribe from three additional lists:
disable_hasoffers_education_email (deprecated, but still unsubscribable); disable_hasoffers_updates_email (deprecated, but still unsubscribable); disable_hasoffers_news_email.
Name | Type | Description |
---|---|---|
NetworkId | Url | Network ID |
NetworkToken | String | Network token |
Target | String | This calls action target |
Method | String | This calls action method |
preference | String | The user_preferences key to use to unsubscribeShow Supported Values |
type | String | Account typeShow Supported Values |
user_id | Integer | The ID of this user (affiliate_user.id, advertiser_user.id, employee.id). |
ttl | String | The TTL in a format that strtotime() can parse |
GET Response Notes
An array with two keys (link, hash) if the
unsubscribe link was successfully generated
and false if an error occurred.
Return response will be in one of the following formats: array, boolean.
API Call Builder
Javascript is required to use the API Call Builder.