Synupv1
Criar chave
v1Recursos/Clients/patchAtualizar um cliente

Atualizar um cliente

Edita os campos editáveis de um cliente existente. Envie apenas os campos que deseja alterar. O primaryContactEmail do cliente (o login do portal) só pode ser definido aqui enquanto ainda estiver vazio — nunca pode ser alterado depois de definido.

patch/api/v1/clients/{id}
clients:write
Parâmetros de consulta
idstringobrigatório
O cliente a atualizar.
Corpo da solicitação
businessNamestringopcional
O nome comercial do novo cliente.
industrystringopcional
O setor de atuação do cliente.
websitestringopcional
A URL do site do cliente.
primaryContactNamestringopcional
O nome do contato principal.
phonestringopcional
O número de telefone do cliente.
locationCountnumberopcional
O número de locais informado pelo cliente — apenas informativo, não o número real de locais criados.
citystringopcional
A cidade do cliente.
phoneCountryCodestringopcional
O país em código ISO-3166-1 alfa-2 ao qual o número de telefone do cliente pertence (por exemplo, "US", "IN") — a região, não o código de discagem.
countrystringopcional
O país do cliente, como código ISO-3166-1 alfa-2.
statestringopcional
O estado, província ou região do cliente.
trackingKeywordstringopcional
Uma palavra-chave para monitorar o ranking de busca local do cliente.
notesstringopcional
Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.
gbpLinkstringopcional
A URL do perfil comercial do Google do cliente.
packageTypestringopcional
O tipo de pacote do cliente.
clientPlanIdstringopcional
Qual plano de portal do cliente atribuir. O padrão é o plano padrão da sua agência. Não há um endpoint que liste os planos — obtenha um ID válido a partir do clientPlan.id de um cliente existente, ou das configurações de plano da sua agência no Synup.
primaryRepresentativeIdstringopcional
O ID de usuário do membro da equipe proprietário deste cliente — consulte GET /api/v1/team/members para os IDs de membros da sua agência.
visibilitystring (public | private)opcional
Se o cliente é public ou private dentro da sua agência.
primaryContactEmailstringopcional
E-mail do contato principal do cliente. Só pode ser definido enquanto ainda estiver vazio — torna-se o login do portal e nunca pode ser alterado depois de definido.
Resposta
dataobjectopcional
Podem existir campos internos adicionais que não fazem parte do contrato estável — baseie-se apenas nos campos documentados aqui.
idstringopcional
Identificador único do cliente.
businessNamestringopcional
O nome comercial do cliente.
websitestringopcional
A URL do site do cliente.
industrystringopcional
O setor de atuação do cliente.
primaryContactEmailstringopcional
E-mail do contato principal do cliente.
primaryRepresentativeIdstringopcional
ID do membro da equipe responsável por este cliente — consulte GET /api/v1/team/members para os IDs de membros da sua agência.
visibilitystring (public | private)opcional
Se o cliente é public ou private dentro da sua agência.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
O objetivo principal do cliente, ou null.
notesstringopcional
Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.
gbpLinkstringopcional
A URL do perfil comercial do Google do cliente, ou null.
trackingKeywordstringopcional
Uma palavra-chave monitorada para o ranking de busca local deste cliente, ou null.
healthScorenumberopcional
Uma pontuação de 0 a 100 que resume a saúde da conta do cliente, ou null se ainda não calculada.
planNamestringopcional
Nome do plano deste cliente, se houver.
archivedbooleanopcional
Se o cliente está arquivado.
archivedAtstringopcional
Data em que o cliente foi arquivado, como timestamp ISO 8601, ou null.
scheduledArchiveAtstringopcional
Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.
createdAtstringopcional
Data de criação do cliente, como timestamp ISO 8601.
updatedAtstringopcional
Data da última atualização do cliente, como timestamp ISO 8601.
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.
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.
patch/api/v1/clients/{id}
Sua chave de API
id *
Corpo da solicitação
{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T09:30:00.000Z"
  }
}