Update Mailing Preferences
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Lets you exclude a lead from receiving emails of a specific category. To use this API –
- Pass the “LeadId” in the API URL.
- Pass “Attribute”: “MailingPreferences” in the JSON body and specify the numeric code of the email category you want to exclude the lead from.
To find email category codes, navigate to My Account>Settings>Email Settings>Email Categories.
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/Lead.Update?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId
URL Parameters
| Parameter | Description |
|---|---|
| LeadId | The Id of the lead. |
Request
Content-Type: application/jsonJSON Body/Payload
[
{ "Attribute": "MailingPreferences", "Value": "53,54"}
]
Request Parameters
| Parameter | Description |
|---|---|
| MailingPreferences | The list of email categories you want to exclude the lead from. Pass the comma-separated numeric code of the email categories. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"AffectedRows": 1
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
