v1Resources/Clients/postSend the client-portal invite
Send the client-portal invite
Sends (or resends) the customer-portal invite email to a client's primary contact — a passwordless magic link. Resending invalidates any previously sent link. Fails if the client has no primaryContactEmail set.
post
clients:write/api/v1/clients/{id}/inviteQuery parameters
idstringrequired
The client to invite.
Response
dataobjectoptional
portalLinkstringoptional
The magic-link URL that was sent in the invite email.
Errors
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.
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/clients/{id}/invite
Your API key
id *
{
"data": {
"portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
}
}Guides that use this endpoint
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build a White-Label Local Marketing PlatformBuild a multi-tenant white-label local marketing platform on the API, with client provisioning, team access, per-client summaries and scoped API keys.