i4w_sync_contacts
Usage
This module provides a mechanism to (one-way) update the entire local Contact cache table (_isContact).
This module can be triggered from a server-side CRON job.
This module can be called through 'Send an http post…' from within an Keap application.
This module can be called manually by typing the URL in your browser.
Parameters
| Parameter | Value | Description |
|---|---|---|
| i4w_sync_contacts | YOUR_SECURITY_KEY | Specifies the action to perform. |
| tags | 234,456 | Specifies a list of comma-separated tag ID to use as a filter for the data sync. |
| tags | memberships | Specifies that all memberships defined on the site will be used as a filter for the data sync. |
| tag_mode | any | Specifies that any of the tag ID's may match in order to qualify. |
| tag_mode | all | Specifies that all of the tag ID's must match in order to qualify. |
| truncate | yes | For larger databases, specifies that the table should be truncated/emptied before begin of the synchronization rather than update record by record. |
Example
- All Contacts
- Tags (OR)
- Tags (any)
- Tags (all)
- Memberships
- With Truncate
Will sync ALL contacts from Keap into the local contact table.
https://www.yoursite.com/?i4w_sync_contacts=YOUR_SECURITY_KEY
Will sync ALL contacts from Keap who have tag ID's 123 OR 234.
https://www.yoursite.com/?i4w_sync_contacts=YOUR_SECURITY_KEY&tags=123,234
Will sync ALL contacts from Keap who have tag ID's 123 OR 234.
https://www.yoursite.com/?i4w_sync_contacts=YOUR_SECURITY_KEY&tags=123,234&tag_mode=any
Will sync ALL contacts from Keap who have tag ID's 123 AND 234.
https://www.yoursite.com/?i4w_sync_contacts=YOUR_SECURITY_KEY&tags=123,234&tag_mode=all
Will sync ALL contacts from Keap who have ANY of the membership tags defined on the site.
https://www.yoursite.com/?i4w_sync_contacts=YOUR_SECURITY_KEY&tags=memberships&tag_mode=any
Will sync ALL contacts from Keap into the local contact table but will first truncate/empty the table.
https://www.yoursite.com/?i4w_sync_contacts=YOUR_SECURITY_KEY&truncate=yes
Notes
In all examples provided, YOUR_SECURITY_KEY stand for the security key defined under plugin options. These are used to authenticate the request.