Synup
Criar chave
v1Recursos/Review Invites/postAtualizar campos de campanhas de avaliações

Atualizar campos de campanhas de avaliações

Cria, renomeia ou arquiva um campo personalizado das campanhas de avaliações de um local, ou define valores nelas. Envie locationId, um mutationId e um command.

post/api/v1/review-invites/campaign-fields
review-invite:write
Corpo da solicitação
locationIdstringobrigatório
ID do local cujo conjunto de campos você está alterando. Para prompts AEO, o site.
mutationIdstringobrigatório
Um UUID que você escolhe para esta alteração. Reenviá-lo com o mesmo command retorna o primeiro resultado sem aplicar a alteração de novo; reutilizá-lo com um command diferente retorna 409.
commandobjectobrigatório
Uma alteração. field_create adiciona um campo com label, type e options. field_update renomeia um campo, altera suas opções ou o arquiva ou restaura, e exige a versão atual do campo como expectedVersion. values_update define de 1 a 1000 valores, cada um com recordId, fieldId, value e expectedVersion, e aplica todos ou nenhum. Uma opção que registros ainda usam não pode ser removida; arquive-a em vez disso. Um conjunto de campos comporta no máximo 40 campos, incluindo os arquivados.
Resposta
dataobjectopcional
resultobjectopcional
O que a alteração fez: o id do campo para field_create e field_update, ou o número de valores gravados para values_update.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
413O corpo da requisição é maior que 1 MB.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Siga as orientações de nova tentativa para esta operação.
post/api/v1/review-invites/campaign-fields
Sua chave de API
Corpo da solicitação*
{}

Guias que usam este recurso