TRtrytoku
Campaigns

Crear Campaign manual

Changed on

Crea una campaña manual, acotada por start_date y finish_date.

Se usa cuando los envíos no se programan por adelantado, sino que se revisan y disparan después desde la aplicación: a diferencia de la campaña programada, esta operación no agenda ningún envío y por eso no acepta outbound_dates.

La campaña queda vacía; las deudas a contactar se asocian con POST /campaigns/manual/invoices.

post/campaigns/manual

Request

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

finish_datestring date required

Fecha en que se termina la campaña. Debe caer entre hoy y los próximos 56 días.

intentionstring

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

namestring required

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

sequencestring

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

start_datestring date required

Fecha en que se inicia la campaña. Debe caer entre hoy y los próximos 56 días.

Example request

{
  "finish_date": "2020-08-16",
  "intention": "cin_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "name": "Campaña Nov. Recordatorio",
  "sequence": "seq_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "start_date": "2020-08-16"
}

Response

La campaña fue creada, sin envíos agendados.

id_campaignstring required

Identificador público de la campaña creada. Se necesita para asociarle deudas y para archivarla más adelante.

messagestring required

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

Example response

{
  "id_campaign": "cam_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "message": "Associations made succesfully"
}

Changes