TRtrytoku
Campaigns

Editar Campaign

Changed on

Reemplaza el nombre, la Sequence o la Intention de una campaña y reagenda sus envíos.

Se usa para corregir una campaña programada que aún no terminó. Los envíos pendientes se eliminan y se vuelven a agendar a partir de outbound_dates, por lo que hay que enviar la lista completa de fechas y no solo las nuevas. Las fechas ya pasadas no se reagendan.

Rige el mismo ajuste de hora que al crear la campaña, con todays_outbound_delay_in_minutes en 2 minutos por defecto. La edición se rechaza si alguna fecha ajustada cae en un feriado del país.

El usuario que viene en x-jwt-user queda registrado como el último editor de la campaña, igual que el autor al crearla. Una edición sin ese dato no borra al editor anterior.

put/edit-campaign

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/edit-campaign
  • Auth
    API key in header x-api-key

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Request body

id_campaignstring required

Identificador público de la campaña que se edita.

intentionstring

Identificador público de la Intention que define el mensaje a enviar. Se entrega intention o sequence, nunca ambos.

is_weeklyboolean

Cuando es true se omite el aviso de carga de pagos; en caso contrario se intenta agendar 25 horas antes de cada envío, si ese momento no pasó aún.

namestring required

Nombre con el que se identifica la campaña dentro de la aplicación.

outbound_datesstring[]

Fechas en las que se envía el contacto masivo. Se aceptan hasta 28 fechas, y cada una debe estar en el futuro y dentro de los próximos 56 días.

sequencestring

Identificador público de la Sequence que define los recordatorios a enviar. Se entrega intention o sequence, nunca ambos.

todays_outbound_delay_in_minutesinteger

Minutos de espera antes de enviar cuando una de las fechas es hoy y su hora de envío ya pasó o queda dentro de este margen. Si al sumarlos se alcanza la hora de corte del país, el envío se agenda para el día siguiente.

Example request

{
  "id_campaign": "cam_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "intention": "cin_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "name": "Campaña Nov. Recordatorio",
  "outbound_dates": [
    "2021-08-16T19:20:30-04:00",
    "2021-08-25T19:20:30-04:00"
  ],
  "sequence": "seq_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T"
}

Response

La campaña fue editada y sus envíos quedaron reagendados.

is_scheduled_for_tomorrowboolean required

true cuando alguna de las fechas pedidas era hoy y, tras aplicar la hora de envío y la hora de corte del país, ninguna quedó agendada para hoy.

messagestring required

Descripción legible del resultado de la operación.

Example response

{
  "message": "Associations made succesfully"
}

Changes