Synup
Create a key
v1Resources/Review Invites/postPreview or import CRM contacts

Preview or import CRM contacts

Requires ReviewGen, Reviews access, an unrestricted agency owner/admin and an unrestricted credential. POST always requires review-invite:write. op:preview fetches live connected CRM contacts without saving; limit defaults to 500 and accepts 1–5000. Optional mapping applies only to preview and is never saved. op:import uses saved routing and the background job’s limit; mapping and limit are refused. Imports can send email/SMS and consume Credits, so allowSend:true is mandatory after explicit approval of those sends. Returns HTTP 202 with runId and status:queued, not completed counts. HTTP 503 with data.status:queue_unknown and runId means queue confirmation failed: check that run before starting another. Preview omits raw provider records and internal planning data.

post/api/v1/review-invites/crm/{id}/import
review-invite:write
Query parameters
idstringrequired
Request body
opstring (preview | import)optional
mappingobjectoptional
sourceFieldstringrequired
rulesarray of objectrequired
valuestringrequired
locationIdstringrequired
fallbackLocationIdstringrequired
limitintegeroptional
allowSendbooleanoptional
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The record changed, delivery requires approval, or the operation conflicts with existing state.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The invitation operation could not be completed. An uncertain CRM queue result retains runId; check it before retrying.
post/api/v1/review-invites/crm/{id}/import
Your API key
id *
Request body
{}

Guides that use this resource