Crea un regalo o promocion

Mismos campos que el formulario del dashboard. Se crea inactiva; active con POST /promociones/{regaloId}/status.

Scope requerido: promociones:write

Escritura: header Idempotency-Key obligatorio.

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

Mismos campos que el formulario del dashboard. Se crea inactiva; active con POST /promociones/{regaloId}/status.

Scope requeridopromociones:write
MétodoPOST /ext/v3/promociones
Idempotenciaheader Idempotency-Key obligatorio

Body

ParámetroTipoRequeridoDescripción
rTitulostringsíTitulo del regalo
rDescripcionstringno
rTipointegersíTipo de regalo, mismo catalogo del dashboard. Conocidos: 4 punch card (usa punchVMax y las imagenes punch*), 101 codigo promocional unico (codigoPromocion), 103 codigo promocional multicodigo, 200 canje con codigo externo (mensaje = codigo), 7 juego (se crea por POST /juegos). Los demas tipos numericos son regalos/cupones simples segun el dashboard.
rValorstringnoValor del regalo (monto, porcentaje o producto segun el tipo)
rImagenstringnoURL de la imagen
rExpiracionDiasintegernoVence N dias despues de asignado
rExpiracionFechastringnoFecha fija de vencimiento YYYY-MM-DD
rExpiracionDiaMesstringnoVence un dia del mes
codigoPromocionstringnoCodigo promocional
mensajestringnoMensaje push al asignar
punchVMaxintegernoPunch card: perforaciones para completar
punchImgBgstringno
punchImgLlenostringno
punchImgVaciastringno

Ejemplo

curl -X POST 'https://api3.clau.io/ext/v3/promociones' \
  -H 'apikey: ck_1_...' \
  -H 'Idempotency-Key: 6f1e2d3c-0001' \
  -H 'Content-Type: application/json' \
  -d '{"rTitulo":"Cafe gratis","rTipo":101}'

Respuesta 200

{
  "codigoRespuesta": 0,
  "msj": "Exito",
  "data": "…",
  "meta": {
    "requestId": "5f1c…",
    "appId": 1,
    "scope": "promociones: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.

Query Params
boolean

Con true devuelve la ayuda del endpoint en texto plano.

Body Params
string
required
length ≤ 200

Titulo del regalo

string
length ≤ 2000
integer
required

Tipo de regalo, mismo catalogo del dashboard. Conocidos: 4 punch card (usa punchVMax y las imagenes punch*), 101 codigo promocional unico (codigoPromocion), 103 codigo promocional multicodigo, 200 canje con codigo externo (mensaje = codigo), 7 juego (se crea por POST /juegos). Los demas tipos numericos son regalos/cupones simples segun el dashboard.

string
length ≤ 120

Valor del regalo (monto, porcentaje o producto segun el tipo)

string
length ≤ 500

URL de la imagen

integer
≥ 0

Vence N dias despues de asignado

string
length ≤ 30

Fecha fija de vencimiento YYYY-MM-DD

string
length ≤ 30

Vence un dia del mes

string
length ≤ 60

Codigo promocional

string
length ≤ 500

Mensaje push al asignar

integer
≥ 0

Punch card: perforaciones para completar

string
length ≤ 500
string
length ≤ 500
string
length ≤ 500
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