PUT https://api.actonsoftware.com/api/1/subscription/optout
This endpoint allows you to update a records subscription based on their email.
Customers wanting to access our API via our gateway in the EU can use this link:
PUT https://api-eu.actonsoftware.com/api/1/subscription/optout
Parameters
Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
---|---|---|---|---|---|
Authorization | Header | False | Required | String | Insert your generated access token. ("Bearer {access token}") |
Body | False | Required | String | Specify the email address of the record. | |
category | Body | False | Required | String | Specify the category to be updated. |
action | Body | False | Optional | String | Specify if recorded subscription status. ("optin", "optout") |
Response
{ "status": "success", "message": "OptIn entry added for subscription category : Newsletter" }
Code Examples
cURL
curl -X PUT https://api.actonsoftware.com/api/1/subscription/optout -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs" -H "Content-Type: application/x-www-form-urlencoded" -d 'email=john.dor%40act-on.com&category=Newsletter'