Synup
Crear clave
v1Recursos/Reviews/postAgregar un competidor

Agregar un competidor

Comienza a rastrear un competidor por nombre — para una sola ubicación (pase locationId y clientId), o a nivel de cliente como competidor conjunto mostrado en todas las ubicaciones de ese cliente (pase solo clientId).

post/api/v1/reviews/competitors
reviews:write
Cuerpo de la solicitud
locationIdstringopcional
La ubicación para la que rastrear este competidor. Omítalo junto con clientId solo para agregar en su lugar un competidor conjunto a nivel de cliente.
clientIdstringopcional
El cliente de la ubicación, obligatorio junto con locationId; o, por sí solo, el cliente para el que agregar un competidor conjunto.
namestringobligatorio
El nombre comercial del competidor.
Respuesta
dataobjectopcional
competitorobjectopcional
Fila de perfil de un competidor (id, nombre, origen, fijado, etc.).
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/reviews/competitors
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "competitor": {
      "id": "cm_comp_1",
      "kind": "competitor",
      "source": "manual",
      "name": "Smile Bright Dental",
      "placeId": null,
      "address": null,
      "lastUpdated": null,
      "avgRating": null,
      "reviewCount": null
    }
  }
}

Guías que usan este endpoint