Synupv1
Criar chave
v1Recursos/Clients/postCriar um cliente

Criar um cliente

Cria um novo cliente na sua agência, além de um primeiro local quando os dados de endereço correspondem a um lugar real.

post/api/v1/clients
clients:write
Corpo da solicitação
businessNamestringobrigatório
O nome comercial do novo cliente.
primaryContactEmailstringobrigatório
E-mail do contato principal do cliente.
primaryRepresentativeIdstringobrigatório
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.
websitestringopcional
A URL do site do cliente.
industrystringopcional
O setor de atuação do cliente.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
O objetivo principal do cliente: improve_rankings, get_reviews ou fix_listings.
gbpLinkstringopcional
A URL do perfil comercial do Google do cliente.
placeIdstringopcional
O Place ID do Google do cliente, da API Places do Google — o Synup não oferece uma busca de locais própria. Também cria o primeiro local do cliente — não faça em seguida uma criação de local separada para o mesmo negócio.
latitudenumberopcional
A latitude do local do cliente. Necessária junto com placeId e longitude para também monitorar uma palavra-chave.
longitudenumberopcional
A longitude do local do cliente.
googleRatingnumberopcional
A avaliação atual em estrelas do Google do cliente, se conhecida.
googleReviewCountnumberopcional
O número atual de avaliações do Google do cliente, se conhecido.
trackingKeywordstringopcional
Uma palavra-chave para monitorar o ranking de busca local do cliente. Requer que placeId, latitude e longitude também estejam definidos.
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.
notesstringopcional
Uma nota interna sobre o cliente — visível apenas para a sua equipe, nunca para o cliente.
Resposta
dataobjectopcional
clientobjectopcional
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.
locationIdstringopcional
ID do primeiro local criado junto com este cliente, ou null se nenhum pôde ser criado ainda.
locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)opcional
Por que nenhum primeiro local foi criado, quando um placeId foi informado mas nenhum local resultou disso — por exemplo, location_limit significa que a agência atingiu o limite de locais do seu plano. Null quando não aplicável.
Erros
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.
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/clients
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "client": {
      "id": "cli_123",
      "businessName": "Acme Dental",
      "website": null,
      "industry": null,
      "primaryContactEmail": "owner@acmedental.com",
      "primaryRepresentativeId": "usr_123",
      "visibility": "public",
      "goal": null,
      "notes": null,
      "gbpLink": null,
      "trackingKeyword": null,
      "healthScore": null,
      "planName": null,
      "archived": false,
      "archivedAt": null,
      "scheduledArchiveAt": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    "locationId": "loc_456",
    "locationSkipped": null
  }
}