Agendar Canvas disparados por API
Use este endpoint para agendar mensagens do Canvas por meio de entrega disparada por API. Assim, você pode decidir qual ação deve disparar o envio da mensagem.
Você pode passar um context, cujo conteúdo será inserido nas mensagens enviadas pelas primeiras etapas do Canvas.
A terminologia e o namespace Liquid que você vê dependem dos recursos disponíveis no seu espaço de trabalho:
- Se o dashboard exibe Context Variables, referencie as propriedades de entrada com
context, como{{context.${property_name}}}. Você também pode criar ou atualizar variáveis com uma etapa de Contexto. - Se o dashboard exibe Canvas Entry Properties, referencie-as com
canvas_entry_properties, como{{canvas_entry_properties.${property_name}}}. A etapa de Contexto e o filtro Context Variable não estão disponíveis.
Para saber mais, consulte Contexto e Propriedades de contexto e evento. Se você precisa de acesso ao Canvas Context, entre em contato com seu gerente de sucesso do cliente.
Para enviar mensagens com este endpoint, você precisa ter um ID do Canvas, que é gerado quando você cria um Canvas.
As entradas no Canvas são registradas no horário agendado da mensagem, e não no momento em que esta solicitação de API é feita. Os usuários disparados para um agendamento com data futura só aparecerão como entradas quando chegar o horário agendado.
Endpoint reference
This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/pt-br/assets/api/openapi/messaging_schedule_messages_post_schedule_triggered_canvases.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.