v1Resources/Review Invites/postAdd recipients to a campaign
Add recipients to a campaign
Adds one or more recipients to a review-invite campaign, deduplicated against the batch itself and against everyone already on the campaign. Warning — this can trigger a real message send: if the target campaign is already launched with auto-send on, the newly added recipients are queued and sent to immediately, on their real email address or phone number.
post
review-invite:write/api/v1/review-invitesRequest body
campaignIdstringrequired
The campaign to add recipients to. Required.
recipientsarray of objectrequired
The recipients to add. Required, non-empty.
namestringoptional
Recipient's name.
emailstringoptional
Recipient's email address.
phonestringoptional
Recipient's phone number.
sourcestringoptional
Where this recipient came from. Defaults to manual.
contactTypestring (Customer | Lead | Prospect | Contact)optional
One of: Customer, Lead, Prospect, Contact. Defaults to Customer.
channelstringoptional
Which channel to message this recipient on (e.g. email, sms), or omit to use the campaign's default mix.
smsConsentobjectoptional
SMS consent attestation for this batch. Required for any recipient in the batch to be messaged by SMS — rows added without it are skipped for SMS sending.
bystringoptional
Name or identifier of the person who attests consent was obtained for this batch.
Response
dataobjectoptional
countnumberoptional
Number of recipients actually added.
duplicatesnumberoptional
Number of rows in the request batch itself that duplicated another row in the same batch.
alreadyPresentnumberoptional
Number of rows that were skipped because that email or phone was already on this campaign.
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/review-invites
Your API key
Request body*
{
"data": {
"count": 1,
"duplicates": 0,
"alreadyPresent": 0
}
}