Pause saved search alerts
Stops the Property Alert and/or Market Snapshot emails of a lead without deleting the searches. Select either by category (every search of the given kinds) or by id, not both. Searches already switched off are reported as ALREADY_INACTIVE and left untouched, so repeating the call is safe. Resume restores the cadence each search had before (previousAlertFrequency in the result).
curl --request POST \
--url https://api.lofty.com/v1.0/leads/{leadId}/savedSearches/pause \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"categories": [
"PROPERTY_ALERT",
"MARKET_SNAPSHOT"
]
}
'{
"results": [
{
"id": 88123456789,
"category": "PROPERTY_ALERT",
"result": "PAUSED",
"previousAlertFrequency": "NEVER",
"alertFrequency": "NEVER",
"status": "ACTIVE",
"message": "<string>"
}
]
}Path Parameters
ID of the lead whose alerts to pause.
x >= 1Body
Give either categories or savedSearchIds, not both.
Pause every saved search of the lead of the given kinds. Give either categories or savedSearchIds, not both.
PROPERTY_ALERT, MARKET_SNAPSHOT Pause the listed saved searches of the lead, whatever their kind. Give either categories or savedSearchIds, not both. A repeated id is paused once.
Response
Success. A request rejected by validation or by a business rule also answers HTTP 200, with {"code": <error code>, "message": "..."} in place of the result: check code in the body, not the HTTP status. Codes are listed under Errors in the Saved Searches section.
One entry per saved search the call selected
Show child attributes
Show child attributes
curl --request POST \
--url https://api.lofty.com/v1.0/leads/{leadId}/savedSearches/pause \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"categories": [
"PROPERTY_ALERT",
"MARKET_SNAPSHOT"
]
}
'{
"results": [
{
"id": 88123456789,
"category": "PROPERTY_ALERT",
"result": "PAUSED",
"previousAlertFrequency": "NEVER",
"alertFrequency": "NEVER",
"status": "ACTIVE",
"message": "<string>"
}
]
}