Synup
Create a key
v1Resources/Clients/postSend the client-portal invite

Send the client-portal invite

Send or resend an invitation to the primary contact, or provide clientUserId for a non-disabled user awaiting their first sign-in. No body retains the primary-contact behavior; malformed JSON is refused. Returns the sent portalLink. Previously issued links remain independently valid until used or their seven-day expiry. Requires the identified credential owner’s access to this client.

post/api/v1/clients/{id}/invite
clients:write
Query parameters
idstringrequired
The client to invite.
Request body
clientUserIdstringoptional
Response
dataobjectoptional
heldbooleanoptional
True when the invite is waiting for your agency's email sending domain to be verified. Nothing has been sent yet and portalLink is null. It's sent automatically once the domain is verified.
reasonstring (sending_domain_unverified)optional
portalLinkstringoptional
The magic-link URL that was sent in the invite email.
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 request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Follow the retry guidance for this operation.
post/api/v1/clients/{id}/invite
Your API key
id *
Request body
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

Guides that use this endpoint