Synupv1
Crear clave
v1Recursos/Clients/patchActualizar un cliente

Actualizar un cliente

Edita los campos editables de un cliente existente. Envíe solo los campos que desea cambiar. El primaryContactEmail del cliente (su acceso al portal) solo puede establecerse aquí mientras esté vacío — nunca puede cambiarse una vez establecido.

patch/api/v1/clients/{id}
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a actualizar.
Cuerpo de la solicitud
businessNamestringopcional
El nombre comercial del nuevo cliente.
industrystringopcional
El sector del cliente.
websitestringopcional
La URL del sitio web del cliente.
primaryContactNamestringopcional
El nombre del contacto principal.
phonestringopcional
El número de teléfono del cliente.
locationCountnumberopcional
El número de ubicaciones declarado por el cliente — solo informativo, no el número real de ubicaciones creadas.
citystringopcional
La ciudad del cliente.
phoneCountryCodestringopcional
El país en código ISO-3166-1 alfa-2 al que pertenece el número de teléfono del cliente (p. ej. "US", "IN") — la región, no el prefijo telefónico.
countrystringopcional
El país del cliente, como código ISO-3166-1 alfa-2.
statestringopcional
El estado, provincia o región del cliente.
trackingKeywordstringopcional
Una palabra clave para rastrear el posicionamiento local del cliente.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente.
packageTypestringopcional
El tipo de paquete del cliente.
clientPlanIdstringopcional
Qué plan de portal de clientes asignar. Por defecto, el plan predeterminado de su agencia. No hay un endpoint que liste los planes — obtenga un ID válido del clientPlan.id de un cliente existente o de la configuración de planes de su agencia en Synup.
primaryRepresentativeIdstringopcional
El ID de usuario del miembro del equipo propietario de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
visibilitystring (public | private)opcional
Si el cliente es public o private dentro de su agencia.
primaryContactEmailstringopcional
Correo electrónico del contacto principal del cliente. Solo se puede establecer mientras esté vacío — se convierte en el acceso al portal y nunca puede cambiarse una vez establecido.
Respuesta
dataobjectopcional
Puede haber campos internos adicionales que no forman parte del contrato estable — dependa únicamente de los campos documentados aquí.
idstringopcional
Identificador único del cliente.
businessNamestringopcional
El nombre comercial del cliente.
websitestringopcional
La URL del sitio web del cliente.
industrystringopcional
El sector del cliente.
primaryContactEmailstringopcional
Correo electrónico del contacto principal del cliente.
primaryRepresentativeIdstringopcional
ID del miembro del equipo responsable de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
visibilitystring (public | private)opcional
Si el cliente es public o private dentro de su agencia.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente, o null.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente, o null.
trackingKeywordstringopcional
Una palabra clave rastreada para el posicionamiento local de este cliente, o null.
healthScorenumberopcional
Una puntuación de 0 a 100 que resume la salud de la cuenta del cliente, o null si aún no se ha calculado.
planNamestringopcional
Nombre del plan de este cliente, si tiene uno.
archivedbooleanopcional
Si el cliente está archivado.
archivedAtstringopcional
Fecha en que se archivó el cliente, como marca de tiempo ISO 8601, o null.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
createdAtstringopcional
Fecha de creación del cliente, como marca de tiempo ISO 8601.
updatedAtstringopcional
Fecha de la última actualización del cliente, como marca de tiempo ISO 8601.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/clients/{id}
Su clave de API
id *
Cuerpo de la solicitud
{
  "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"
  }
}