Ir al contenido

Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Programar Canvas desencadenados por la API

post

/canvas/trigger/schedule/create

core endpoint

Utiliza este endpoint para programar mensajes de Canvas a través de la entrega desencadenada por la API, lo que te permite decidir qué acción debe desencadenar el envío del mensaje.

Puedes pasar context que se aplicará como plantilla en los mensajes enviados por los primeros pasos del Canvas.

Importante

La terminología y el espacio de nombres de Liquid que ves dependen de las características disponibles en tu espacio de trabajo:

Si el panel muestra Variables de contexto, haz referencia a las propiedades de entrada con context, como {{context.${property_name}}}. También puedes crear o actualizar variables con un paso de contexto.
Si el panel muestra Propiedades de entrada de Canvas, haz referencia a ellas con canvas_entry_properties, como {{canvas_entry_properties.${property_name}}}. El paso de contexto y el filtro Variable de contexto no están disponibles.

Para más información, consulta Contexto y Propiedades de contexto y de evento. Si necesitas acceso al contexto de Canvas, ponte en contacto con tu administrador de éxito de cliente.

Ten en cuenta que para enviar mensajes con este endpoint, debes tener un ID de Canvas, creado cuando construyes un Canvas.

Nota

Las entradas de Canvas se registran en el momento del mensaje programado, no cuando se realiza esta solicitud de API. Los usuarios desencadenados para una programación con fecha futura no aparecerán como entradas hasta que llegue esa hora programada.

See me in Postman

Requisitos previos

Para utilizar este endpoint, necesitarás una clave de API con el permiso canvas.trigger.schedule.create.

Límite de velocidad

Cuando utilizas filtros de audiencia conectada en tu solicitud, este endpoint tiene un límite de velocidad de 250 solicitudes por minuto. De lo contrario, si especificas un external_id, este endpoint tiene un límite de velocidad predeterminado de 250 000 solicitudes por hora, compartido entre los endpoints documentados en Límites de velocidad de la API.

Este endpoint admite solicitudes de API por lotes. Una solicitud puede incluir cualquiera de los siguientes elementos:

Hasta 50 recipients de forma predeterminada
Una audiencia conectada de cualquier tamaño

Cuerpo de la solicitud

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

{
  "canvas_id": (required, string) see Canvas identifier,
  // Including 'recipients' will send only to the provided user ids if they are in the campaign's segment
  "recipients": (optional, array of recipients object),
  // for any keys that conflict between these trigger properties and those in a Recipients Object, the value from the
  // Recipients Object will be used
  "audience": (optional, connected audience object) see connected audience,
  // Including 'audience' will only send to users in the audience
  // If 'recipients' and 'audience' are not provided and broadcast is not set to 'false',
  // the message will send to entire segment targeted by the Canvas
  "broadcast": (optional, boolean) see broadcast -- defaults to false on 8/31/17, must be set to true if "recipients" object is omitted,
  "context": (optional, object) personalization key-value pairs for the first step for all users in this send; see trigger properties,
  "schedule": {
    "time": (required, datetime as ISO 8601 string) time to send the message,
    "in_local_time": (optional, bool),
    "at_optimal_time": (optional, bool),
  }
}

Parámetros de la solicitud

Parámetro	Obligatorio	Tipo de datos	Descripción
`canvas_id`	Obligatorio	Cadena	Ver identificador de Canvas.
`recipients`	Opcional	Matriz de objetos de destinatarios	Ver objeto de destinatarios.
`audience`	Opcional	Objeto de audiencia conectada	Ver audiencia conectada.
`broadcast`	Opcional	Booleano	Debes establecer `broadcast` en true cuando envíes un mensaje a un segmento completo al que se dirige una campaña o un Canvas. Este parámetro tiene como valor predeterminado false (a partir del 31 de agosto de 2017). Si `broadcast` tiene el valor true, no se puede incluir una lista `recipients`. Sin embargo, ten cuidado al configurar `broadcast: true`, ya que si lo haces involuntariamente puede que envíes tu mensaje a una audiencia mayor de la esperada.
`context`	Opcional	Objeto	Pares clave-valor de personalización para todos los usuarios de este envío. Ver objeto de contexto de Canvas.
`schedule`	Obligatorio	Objeto de programación	Ver objeto de programación.

Ejemplo de solicitud

curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/schedule/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "recipients": [
    {
      "user_alias": "example_alias",
      "external_user_id": "external_user_identifier",
      "context": {}
    }
  ],
  "audience": {
    "AND": [
      {
        "custom_attribute": {
          "custom_attribute_name": "eye_color",
          "comparison": "equals",
          "value": "blue"
        }
      },
      {
        "custom_attribute": {
          "custom_attribute_name": "favorite_foods",
          "comparison": "includes_value",
          "value": "pizza"
        }
      },
      {
        "OR": [
          {
            "custom_attribute": {
              "custom_attribute_name": "last_purchase_time",
              "comparison": "less_than_x_days_ago",
              "value": 2
            }
          },
          {
            "push_subscription_status": {
              "comparison": "is",
              "value": "opted_in"
            }
          }
        ]
      },
      {
        "email_subscription_status": {
          "comparison": "is_not",
          "value": "subscribed"
        }
      },
      {
        "last_used_app": {
          "comparison": "after",
          "value": "2019-07-22T13:17:55+0000"
        }
      }
    ]
  },
  "broadcast": false,
  "context": {},
  "schedule": {
    "time": "",
    "in_local_time": false,
    "at_optimal_time": false
  }
}'

Respuesta

Ejemplo de respuesta correcta

Content-Type: application/json
Authorization: Bearer YOUR-API-KEY-HERE
{
{
    "dispatch_id": "dispatch_identifier",
    "schedule_id": "schedule_identifier",
    "message": "success"
}

New Stuff!