Crear o editar la recurrencia de una campania

PUT

/v1/bulk/campaigns/{id}/recurrence

curl --request PUT \
  --url https://api.mailerdash.com/v1/bulk/campaigns/example/recurrence \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rule": { "freq": "weekly", "weekday": 2, "hour": 9, "timezone": "America/Mexico_City" }, "active": true, "ends_at": "example" }'

• Production
• Local development

Una campania tiene como mucho UNA recurrencia, asi que crear y editar son la misma operacion. Cada disparo DUPLICA esta campania y manda la copia: cada envio tiene sus propias metricas y su propia foto de la audiencia.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

rule

La hora es LOCAL de la zona indicada, no UTC: “las 9” tiene que seguir siendo las 9 cuando cambie el horario de verano.

object

freq

required

string

Allowed values: daily weekly monthly

hour

required

integer

<= 23

minute

integer

0 <= 59

timezone

Zona IANA, ej. America/Mexico_City.

string

default: UTC

weekday

0 = domingo. Requerido en weekly, y en monthly con nth.

integer

<= 6

monthday

Dia del mes (1-31) o -1 para el ultimo. Un 31 SALTA los meses cortos en vez de correrse al 30, que seria una fecha que nadie pidio.

integer

nth

Enesimo dia de semana del mes (1-5) o -1 para el ultimo. Excluyente con monthday.

integer

Example

{
  "freq": "weekly",
  "weekday": 2,
  "hour": 9,
  "timezone": "America/Mexico_City"
}

active

boolean

ends_at

Fecha ISO despues de la cual deja de disparar.

string

nullable

Responses

200

Recurrencia guardada

Media type application/json

object

id

string

key_id

string

source_campaign_id

string

rule

La hora es LOCAL de la zona indicada, no UTC: “las 9” tiene que seguir siendo las 9 cuando cambie el horario de verano.

object

freq

required

string

Allowed values: daily weekly monthly

hour

required

integer

<= 23

minute

integer

0 <= 59

timezone

Zona IANA, ej. America/Mexico_City.

string

default: UTC

weekday

0 = domingo. Requerido en weekly, y en monthly con nth.

integer

<= 6

monthday

Dia del mes (1-31) o -1 para el ultimo. Un 31 SALTA los meses cortos en vez de correrse al 30, que seria una fecha que nadie pidio.

integer

nth

Enesimo dia de semana del mes (1-5) o -1 para el ultimo. Excluyente con monthday.

integer

descripcion

string

active

integer

next_run_at

string

nullable

last_run_at

string

nullable

last_campaign_id

string

nullable

ends_at

string

nullable

runs_count

integer

Example

{
  "rule": {
    "freq": "weekly",
    "weekday": 2,
    "hour": 9,
    "timezone": "America/Mexico_City"
  },
  "descripcion": "Cada martes a las 09:00 (America/Mexico_City)"
}

400

Regla invalida

404

Campania no encontrada