Synup
Create a key
v1Resources/Review Invites/postUpdate review campaign fields

Update review campaign fields

Creates, renames or archives a custom field on a location's review campaigns, or sets values on them. Send locationId, a mutationId and one command.

post/api/v1/review-invites/campaign-fields
review-invite:write
Request body
locationIdstringrequired
ID of the location whose field set you're changing. For AEO prompts, the website.
mutationIdstringrequired
A UUID you choose for this change. Resending it with the same command returns the first result without applying the change again; reusing it with a different command returns 409.
commandobjectrequired
One change. field_create adds a field with label, type and options. field_update renames a field, changes its options, or archives or restores it, and needs the field's current version as expectedVersion. values_update sets 1 to 1000 values, each with recordId, fieldId, value and expectedVersion, and applies all or none. An option that records still hold can't be removed; archive it instead. A field set holds at most 40 fields, archived ones included.
Response
dataobjectoptional
resultobjectoptional
What the change did: the field's id for field_create and field_update, or the number of values written for values_update.
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).
413The request body is larger than 1 MB.
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/review-invites/campaign-fields
Your API key
Request body*
{}

Guides that use this resource