v1Recursos/Clients/postAdicionar um usuário ao portal do cliente
Adicionar um usuário ao portal do cliente
Ler usuários salvos sem criar usuários de contato antigos. Adicionar por e-mail, com sendInvite=true por padrão; uma falha de envio preserva o usuário. Alterações apenas ativam, desativam ou transferem propriedade com makePrimary=true. Remover expira links pendentes; um proprietário com outros usuários não pode ser removido. Revogar expira todos os links pendentes e remove apenas convidados que nunca entraram.
post
clients:write/api/v1/clients/{id}/usersParâmetros de consulta
idstringobrigatório
Corpo da solicitação
emailstringobrigatório
firstNamestringopcional
lastNamestringopcional
sendInvitebooleanopcional
Resposta
dataobjectobrigatório
userobjectopcional
idstringopcional
emailstringopcional
firstNamestringopcional
lastNamestringopcional
statusstringopcional
isPrimarybooleanopcional
rolestring (owner | member)opcional
invitedAtstringopcional
lastLoginAtstringopcional
inviteSentAtstringopcional
inviteobjectopcional
sentbooleanopcional
portalLinkstringopcional
reasonstring (portal_domain_required | send_failed)opcional
errorstringopcional
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).
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. Tente adicionar os créditos novamente com a mesma chave de idempotência.
post/api/v1/clients/{id}/users
Sua chave de API
id *
Corpo da solicitação*
{}Guias que usam este recurso
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Create a Location with the Synup APICreate a business location in one POST, with or without a client, get back a locationId, and know which fields matter and which can wait.
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build a White-Label Local Marketing PlatformBuild a multi-tenant white-label local marketing platform on the API, with client provisioning, team access, per-client summaries and scoped API keys.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.