v1Recursos/Clients/postCrear un cliente
Crear un cliente
Crea un nuevo cliente en su agencia, además de una primera ubicación cuando los datos de dirección corresponden a un lugar real.
post
clients:write/api/v1/clientsCuerpo de la solicitud
businessNamestringobligatorio
El nombre comercial del nuevo cliente.
primaryContactEmailstringobligatorio
Correo electrónico del contacto principal del cliente.
primaryRepresentativeIdstringobligatorio
ID del miembro del equipo responsable de este cliente — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
websitestringopcional
La URL del sitio web del cliente.
industrystringopcional
El sector del cliente.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente: improve_rankings, get_reviews o fix_listings.
gbpLinkstringopcional
La URL del perfil de negocio de Google del cliente.
placeIdstringopcional
El Place ID de Google del cliente, de la API de Places de Google — Synup no ofrece una búsqueda de lugares propia. También crea la primera ubicación del cliente — no haga a continuación una creación de ubicación aparte para el mismo negocio.
latitudenumberopcional
La latitud de la ubicación del cliente. Necesaria junto con placeId y longitude para rastrear también una palabra clave.
longitudenumberopcional
La longitud de la ubicación del cliente.
googleRatingnumberopcional
La calificación actual en estrellas de Google del cliente, si se conoce.
googleReviewCountnumberopcional
El número actual de reseñas de Google del cliente, si se conoce.
trackingKeywordstringopcional
Una palabra clave para rastrear el posicionamiento local del cliente. Requiere que placeId, latitude y longitude también estén establecidos.
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.
notesstringopcional
Una nota interna sobre el cliente — visible solo para su equipo, nunca para el cliente.
Respuesta
dataobjectopcional
clientobjectopcional
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.
locationIdstringopcional
ID de la primera ubicación creada junto con este cliente, o null si aún no se pudo crear ninguna.
locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)opcional
Por qué no se creó ninguna primera ubicación, cuando se proporcionó un placeId pero no resultó ninguna ubicación — por ejemplo, location_limit significa que la agencia alcanzó el límite de ubicaciones de su plan. Null cuando no aplica.
Errores
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.
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.
post/api/v1/clients
Su clave de API
Cuerpo de la solicitud*
{
"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
}
}