Synup
Create a key
v1Resources/Review Invites/postUpdate a recipient

Update a recipient

Corrects a recipient's name, email, phone, or contact type. Email and phone are frozen once a message has gone out to that recipient — changing either after a send returns a 409, since delivery receipts and replies are tied to the address actually used.

post/api/v1/review-invites/update
review-invite:write
Request body
recipientIdstringrequired
The recipient to update. Required.
namestringoptional
New name.
emailstringoptional
New email address. Rejected with a 409 if this recipient has already been sent a message.
phonestringoptional
New phone number. Rejected with a 409 if this recipient has already been sent a message.
contactTypestring (Customer | Lead | Prospect | Contact)optional
New contact type: Customer, Lead, Prospect, or Contact.
Response
dataobjectoptional
idstringoptional
Unique identifier for the recipient.
namestringoptional
The recipient's name, or empty if not provided.
emailstringoptional
The recipient's email address, or empty if not provided.
phonestringoptional
The recipient's phone number, or empty if not provided.
contactTypestringoptional
One of: Customer, Lead, Prospect, Contact.
statusstringoptional
Current delivery status for this recipient.
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).
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/review-invites/update
Your API key
Request body*
{
  "data": {
    "id": "cm_recip_1",
    "name": "Jordan Lee",
    "email": "jordan@example.com",
    "phone": null,
    "contactType": "Customer",
    "status": "pending"
  }
}