Refresh Contactfilter-Contacts

Due to the possibly large number of contacts in an account, the set of contacts covered by a certain contactfilter cannot be instantly updated on every change of a contactfilter for a contact. Thus, this method provides the opportunity to trigger recalculation of the set of contacts that are matching the given filter. Notice: Please be aware, that you cannot update the same filter twice at the same time using asynchronous mode (response 429) and you cannot update more than 5 filters at the same time using synchronous mode. The 6th filter refresh will automatically be switched to asynchronous mode.

GET https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}/refresh

Attributes

Parameter	Default	Description
time	-1, which is resolved to the last 30 minutes	The, filter is refreshed if the last update has been before the given (standard epoch) time (in milliseconds, timezone CEST / GMT+2).
async	false	If the value is true, the filter will be evaluated asynchronously, if it is false, it will be evaluated synchronously.

Please note: The epoch has to be provided in milliseconds. If you use PHP, make sure to check if your timestamp is provided in milliseconds. If it is proveded in seconds please multiply the timestamp with 1000. Further warning: There is a system-wide refresh limit of 10 minutes. A filter can be refreshed again after 10 minutes and not faster.

Example

GET https://api.maileon.com/1.0/contactfilters/contactfilter/1/refresh
Content-type: application/vnd.maileon.api+xml
Accept: application/vnd.maileon.api+xml
Authorization: [XXX]

Status: 200 OK

Response

HTTP status code	Body Content	Description
200 Ok		Filter was queued or refreshed
423 Locked	/ <error>	Filter is locked and cannot be refreshed
	<message>Unable to update the requested contact filter with the ID: ‘X’ as it is locked.</message>
	</error>