Agrega o quita puntos a todos los clientes de un grupo

Scope requerido: puntos:write

Accion de grupo: envie primero dryRun: true para ver cuantos clientes afecta; limite group_per_min por key y EXT_V3_MAX_GRUPO clientes por accion.

Escritura: header Idempotency-Key obligatorio.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Agrega o quita puntos a todos los clientes de un grupo

Scope requeridopuntos:write
MétodoPOST /ext/v3/grupos/{grupoId}/puntos
Idempotenciaheader Idempotency-Key obligatorio
Acción de grupoacepta dryRun: true; límite group_per_min

Path

ParámetroTipoRequeridoDescripción
grupoIdintegersíId del grupo (mp_grupo_user_filtro.grupo_u_f_id) creado con POST /segmentos/evaluar

Body

ParámetroTipoRequeridoDescripción
dryRunbooleannoCon true no ejecuta: devuelve cuantos clientes afecta y el costo estimado Default false.
puntosnumbersíPuntos a agregar (negativo para quitar), en la unidad publica (la misma que muestra el dashboard). Limite por llamada: 10000
motivostringnoMotivo (queda en la auditoria)

Ejemplo

curl -X POST 'https://api3.clau.io/ext/v3/grupos/812/puntos' \
  -H 'apikey: ck_1_...' \
  -H 'Idempotency-Key: 6f1e2d3c-0001' \
  -H 'Content-Type: application/json' \
  -d '{"puntos":150,"motivo":"Compensacion ticket 4412"}'

Respuesta 200

{
  "codigoRespuesta": 0,
  "msj": "Exito",
  "data": "…",
  "meta": {
    "requestId": "5f1c…",
    "appId": 1,
    "scope": "puntos:write"
  }
}

Errores: 401 key inválida (9501), 403 sin scope (9503, meta.requiredScope), 400 parámetros (details), 409 idempotencia, 422 regla de negocio (meta.legacy), 429 límite de tasa. Agregue ?help=true para la ayuda en texto plano.

Path Params
integer
required
≥ 1

Id del grupo (mp_grupo_user_filtro.grupo_u_f_id) creado con POST /segmentos/evaluar

Query Params
boolean

Con true devuelve la ayuda del endpoint en texto plano.

Body Params
boolean
Defaults to false

Con true no ejecuta: devuelve cuantos clientes afecta y el costo estimado

number
required

Puntos a agregar (negativo para quitar), en la unidad publica (la misma que muestra el dashboard). Limite por llamada: 10000

string
length ≤ 300

Motivo (queda en la auditoria)

Headers
string
required
length between 8 and 128

Identificador unico de la operacion (8 a 128 caracteres, p. ej. un UUID). Repetir con el mismo cuerpo devuelve la respuesta original; con otro cuerpo responde 409.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json