Synupv1
Criar chave
v1Recursos/Review Invites/postAtualizar um destinatário

Atualizar um destinatário

Corrige o nome, e-mail, telefone ou tipo de contato de um destinatário. E-mail e telefone ficam congelados após uma mensagem ter sido enviada a esse destinatário — alterar qualquer um deles depois de um envio retorna um 409, já que confirmações de entrega e respostas estão vinculadas ao endereço realmente usado.

post/api/v1/review-invites/update
review-invite:write
Corpo da solicitação
recipientIdstringobrigatório
O destinatário a ser atualizado. Obrigatório.
namestringopcional
Novo nome.
emailstringopcional
Novo endereço de e-mail. Rejeitado com um 409 se este destinatário já recebeu uma mensagem.
phonestringopcional
Novo número de telefone. Rejeitado com um 409 se este destinatário já recebeu uma mensagem.
contactTypestring (Customer | Lead | Prospect | Contact)opcional
Novo tipo de contato: Customer, Lead, Prospect ou Contact.
Resposta
dataobjectopcional
idstringopcional
Identificador único do destinatário.
namestringopcional
O nome do destinatário, ou vazio se não informado.
emailstringopcional
O endereço de e-mail do destinatário, ou vazio se não informado.
phonestringopcional
O número de telefone do destinatário, ou vazio se não informado.
contactTypestringopcional
Um de: Customer, Lead, Prospect, Contact.
statusstringopcional
Status de entrega atual para este destinatário.
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).
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/review-invites/update
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "id": "cm_recip_1",
    "name": "Jordan Lee",
    "email": "jordan@example.com",
    "phone": null,
    "contactType": "Customer",
    "status": "pending"
  }
}