TRtrytoku
Campaigns

Crear Campaign con Customers

Changed on

Crea una campaña y le asocia Customers en una sola llamada.

Se usa para armar la campaña a partir de Customers en vez de deudas puntuales, sin necesidad de asociarlos después. Los envíos se agendan en las fechas de outbound_dates usando la hora tal como viene en cada fecha, sin el ajuste por país que aplican POST /campaigns y PUT /edit-campaign.

Reenviar el mismo Customer no duplica la asociación.

post/campaigns/customers

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/campaigns/customers
  • 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

customersstring[]

Identificadores públicos de los Customers que quedan asociados a la campaña.

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

{
  "customers": [
    "cus_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 creada con sus Customers asociados.

idstring required

Identificador público de la campaña creada.

namestring required

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

outbound_datesstring[] required

Fechas de envío de la campaña, tal como llegaron en la solicitud.

sequencestring required

Identificador público de la Sequence que define los recordatorios de la campaña.

Example response

{
  "id": "cam_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "outbound_dates": [
    "2021-08-16T19:20:30-04:00",
    "2021-08-25T19:20:30-04:00"
  ],
  "sequence": "seq_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T"
}

Changes