Crear campaña
Crea una nueva campaña de loyalty. La campaña define cómo se genera el cashback en un pedido —
su alícuota (aliquot/aliquotType), disparador, ventana de validez y tipo de recompensa.
Solo name es estrictamente obligatorio en la API; los demás campos toman valores por defecto.
Una campaña creada con trigger: audience-list se empareja automáticamente con un registro
CampaignAudience que conduce la programación por audiencia.
Try-it values populated from environment ACME (Demo)
Autenticación
Token
Send your user token in the x-guper-authorization header. Endpoints that
support a Public mode (e.g. acúmulo and resgate previews) accept the same
request without the header — Private mode adds customer data and a
confirmation token to the response.
Encabezados
| Name | Type | Description |
|---|---|---|
| x-guper-authorization * | string | User token issued by Guper. Omit only on endpoints that explicitly support a Public mode. |
| Content-Type * | string | Always `application/json` for endpoints that accept a JSON body. |
Cuerpo de la petición
Content-Type:
application/json
{
"name": "Aniversário — 10% cashback",
"displayName": "Feliz aniversário!", // optional
"beneficiaryType": "buyer", // optional, referrer | buyer
"trigger": "purchase", // optional
"eventType": "tier_achieved", // optional
"type": "monetary", // optional, monetary | point | coupon | notification
"isActive": true, // optional
"isDraft": false, // optional
"rewardType": "monetary", // optional, monetary | point
"pointsDividend": 1, // optional
"pointsDivisor": 1, // optional
"aliquot": 1000,
"aliquotType": 0, // optional
"coupon": 0, // optional
"recurrentByOrder": false, // optional
"availabilityMode": "consecutiveDays", // optional, consecutiveDays | dateRange
"delayTime": 86400, // optional
"expiryTime": 1296000, // optional
"expiryPeriod": "<expiryPeriod>", // optional, week | month | year
"dateRangeStart": "2026-03-01T00:00:00-03:00", // optional
"dateRangeEnd": "2026-12-31T23:59:59-03:00", // optional
"initAt": "2026-03-01T00:00:00-03:00",
"finishAt": "2026-03-31T23:59:59-03:00",
"storeGroups": "",
"segmentations": "[]",
"redemptionPolicy": 0, // optional
"messageSequence": "<messageSequence>", // optional
"campaignTag": 0, // optional
"rewardSegmentAdd": "<rewardSegmentAdd>", // optional
"rewardSegmentDel": "<rewardSegmentDel>", // optional
"list": 0, // optional
"reactivateWithActiveCards": false, // optional
"skipWithActiveCards": true, // optional
"reactivationDateStart": "<reactivationDateStart>", // optional
"reactivationDateEnd": "<reactivationDateEnd>" // optional
}
{
"name": "Aniversário — 10% cashback",
"aliquot": 1000,
"initAt": "2026-03-01T00:00:00-03:00",
"finishAt": "2026-03-31T23:59:59-03:00",
"storeGroups": "",
"segmentations": "[]"
}
| Field | Type | Description |
|---|---|---|
| name * | string |
Nombre interno de la campaña (usado en el admin y en los reportes). |
| displayName | string | null |
Nombre mostrado al cliente en mensajes y en la página de smartpos. |
| beneficiaryType | string |
Quién recibe el beneficio. Valor típico: referrer | buyer |
| trigger | enum('purchase','cashback','behavioral','winback','external-events','form-submission','notification','last-chance','audience-list','abandoned-cart','reactivate-reward','member-event','dynamic') |
Evento que dispara la campaña. Ejemplos: |
| eventType | string | null |
Obligatorio cuando
|
| type | string |
Categoría de la campaña (cadena libre interpretada por los reportes). monetary | point | coupon | notification |
| isActive | boolean | int |
Si la campaña está activa. Las inactivas se ignoran en la evaluación. |
| isDraft | boolean | int |
Borrador: guardada pero no publicada (BIT, por defecto |
| rewardType | string |
Tipo de recompensa generada. Valores típicos: monetary | point |
| pointsDividend | integer | null |
Numerador de la razón de conversión de puntos (cuando |
| pointsDivisor | integer | null |
Denominador de la razón de conversión de puntos. |
| aliquot * | integer |
Alícuota de la recompensa. La interpretación depende de
|
| aliquotType | bit (0|1) |
|
| coupon | integer | null |
ID del lote de cupón asociado (modelo Coupon). |
| recurrentByOrder | boolean | int |
Cuando es |
| availabilityMode | string |
Cómo se decide la validez de la tarjeta. Valores comunes: consecutiveDays | dateRange |
| delayTime | integer (seconds) | null |
Días tras la compra hasta que la tarjeta queda canjeable (cuando |
| expiryTime | integer (seconds) | null |
Días contados desde |
| expiryPeriod | string |
Optional calendar-based expiry unit, when expiry is expressed as whole weeks/months/years instead of a raw week | month | year |
| dateRangeStart | string (date-time) | null |
Fecha en que las tarjetas quedan canjeables (cuando |
| dateRangeEnd | string (date-time) | null |
Fecha de expiración de las tarjetas (cuando |
| initAt * | string (date-time) |
Fecha en que la campaña empieza a evaluar pedidos. |
| finishAt * | string (date-time) |
Fecha en que la campaña deja de evaluar pedidos. |
| storeGroups * | string (JSON) — required |
IDs de grupos de tienda donde aplica la campaña. Almacenado como JSON. |
| segmentations * | string (JSON) — required |
Reglas de segmentación aplicadas a la audiencia. Almacenado como JSON. |
| redemptionPolicy | integer | null |
ID de la política de canje usada por las tarjetas generadas por esta campaña. |
| messageSequence | string | null |
ID/clave de la secuencia de mensajes disparada para el cliente. |
| campaignTag | integer | null |
ID de la etiqueta en Register usada para marcar a los clientes alcanzados por la campaña. |
| rewardSegmentAdd | array | string | null |
Segmentos agregados al cliente cuando se dispara la acumulación. Almacenado como JSON. |
| rewardSegmentDel | array | string | null |
Segmentos quitados del cliente cuando se dispara la acumulación. Almacenado como JSON. |
| list | integer | null |
ID de la lista asociada a la campaña (lista de audiencia). |
| reactivateWithActiveCards | boolean | int |
Si la reactivación debe ocurrir aun cuando el cliente todavía tiene tarjetas activas. |
| skipWithActiveCards | boolean | int |
Si se debe ignorar la elegibilidad cuando el cliente ya tiene tarjetas activas de esta campaña. |
| reactivationDateStart | string (date-time) | null |
Inicio de la ventana de reactivación. |
| reactivationDateEnd | string (date-time) | null |
Fin de la ventana de reactivación. |