Skip to main content
Server path: /gleap-engagement-outbound | Type: Application | PCID required: Yes

Tools

ToolDescription
gleap_engagement_outbound_create_bannerCreate a new banner
gleap_engagement_outbound_create_chat_messageCreate a new chat message
gleap_engagement_outbound_create_engagement_emailCreate a new email
gleap_engagement_outbound_create_engagement_push_notificationCreate a new push notification
gleap_engagement_outbound_create_whatsapp_messageCreate a new whatsapp message
gleap_engagement_outbound_delete_bannerDelete an banner
gleap_engagement_outbound_delete_chat_messageDelete an chat message
gleap_engagement_outbound_delete_emailDelete an email
gleap_engagement_outbound_delete_push_notificationDelete a push notification
gleap_engagement_outbound_delete_whatsapp_messageDelete a whatsapp message
gleap_engagement_outbound_get_bannerGet an banner
gleap_engagement_outbound_get_bannersGet all banners
gleap_engagement_outbound_get_chat_messageGet an chat message
gleap_engagement_outbound_get_chat_messagesGet all chat messages
gleap_engagement_outbound_get_emailGet an email
gleap_engagement_outbound_get_emailsGet all emails
gleap_engagement_outbound_get_push_notificationGet a push notification
gleap_engagement_outbound_get_push_notificationsGet all push notification
gleap_engagement_outbound_get_whatsapp_messageGet a whatsapp message
gleap_engagement_outbound_get_whatsapp_messagesGet all whatsapp message
gleap_engagement_outbound_send_email_previewSend email preview
gleap_engagement_outbound_send_whatsapp_template_messageSend a whatsapp template message
gleap_engagement_outbound_update_bannerUpdate an banner
gleap_engagement_outbound_update_chat_messageUpdate an chat message
gleap_engagement_outbound_update_engagement_emailUpdate an email
gleap_engagement_outbound_update_engagement_push_notificationUpdate a push notification
gleap_engagement_outbound_update_whatsapp_messageUpdate a whatsapp message

gleap_engagement_outbound_create_banner

Create a new banner Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

gleap_engagement_outbound_create_chat_message

Create a new chat message Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

gleap_engagement_outbound_create_engagement_email

Create a new email Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

gleap_engagement_outbound_create_engagement_push_notification

Create a new push notification Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

gleap_engagement_outbound_create_whatsapp_message

Create a new whatsapp message Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

gleap_engagement_outbound_delete_banner

Delete an banner Parameters:
ParameterTypeRequiredDefaultDescription
bannerIdstringYesBanner Id

gleap_engagement_outbound_delete_chat_message

Delete an chat message Parameters:
ParameterTypeRequiredDefaultDescription
chatMessageIdstringYesChat Message Id

gleap_engagement_outbound_delete_email

Delete an email Parameters:
ParameterTypeRequiredDefaultDescription
engagementEmailIdstringYesEngagement Email Id

gleap_engagement_outbound_delete_push_notification

Delete a push notification Parameters:
ParameterTypeRequiredDefaultDescription
pushNotificationIdstringYesPush Notification Id

gleap_engagement_outbound_delete_whatsapp_message

Delete a whatsapp message Parameters:
ParameterTypeRequiredDefaultDescription
whatsappMessageIdstringYesWhatsapp Message Id

gleap_engagement_outbound_get_banner

Get an banner Parameters:
ParameterTypeRequiredDefaultDescription
bannerIdstringYesBanner Id

gleap_engagement_outbound_get_banners

Get all banners

gleap_engagement_outbound_get_chat_message

Get an chat message Parameters:
ParameterTypeRequiredDefaultDescription
chatMessageIdstringYesChat Message Id

gleap_engagement_outbound_get_chat_messages

Get all chat messages

gleap_engagement_outbound_get_email

Get an email Parameters:
ParameterTypeRequiredDefaultDescription
engagementEmailIdstringYesEngagement Email Id

gleap_engagement_outbound_get_emails

Get all emails

gleap_engagement_outbound_get_push_notification

Get a push notification Parameters:
ParameterTypeRequiredDefaultDescription
pushNotificationIdstringYesPush Notification Id

gleap_engagement_outbound_get_push_notifications

Get all push notification

gleap_engagement_outbound_get_whatsapp_message

Get a whatsapp message Parameters:
ParameterTypeRequiredDefaultDescription
whatsappMessageIdstringYesWhatsapp Message Id

gleap_engagement_outbound_get_whatsapp_messages

Get all whatsapp message

gleap_engagement_outbound_send_email_preview

Send email preview Parameters:
ParameterTypeRequiredDefaultDescription
engagementEmailIdstringYesEngagement Email Id
emailsany[]YesThe emails value
langstringNoThe lang value

gleap_engagement_outbound_send_whatsapp_template_message

Send a whatsapp template message Parameters:
ParameterTypeRequiredDefaultDescription
channelIdstringYesThe WhatsApp channel ID from your project
customValuesobjectNoConstruct a type with a set of properties K of type T
languageCodestringNoLanguage code (e.g. “en_US”). Falls back to the contact’s language or “en_US”
templateNamestringYesName of the WhatsApp template registered with Meta
tostringYesRecipient phone number (E.164 format, e.g. “+14155552671”)

gleap_engagement_outbound_update_banner

Update an banner Parameters:
ParameterTypeRequiredDefaultDescription
bannerIdstringYesBanner Id
bodyobjectYesRequest body

gleap_engagement_outbound_update_chat_message

Update an chat message Parameters:
ParameterTypeRequiredDefaultDescription
chatMessageIdstringYesChat Message Id
bodyobjectYesRequest body

gleap_engagement_outbound_update_engagement_email

Update an email Parameters:
ParameterTypeRequiredDefaultDescription
engagementEmailIdstringYesEngagement Email Id
bodyobjectYesRequest body

gleap_engagement_outbound_update_engagement_push_notification

Update a push notification Parameters:
ParameterTypeRequiredDefaultDescription
pushNotificationIdstringYesPush Notification Id
bodyobjectYesRequest body

gleap_engagement_outbound_update_whatsapp_message

Update a whatsapp message Parameters:
ParameterTypeRequiredDefaultDescription
whatsappMessageIdstringYesWhatsapp Message Id
bodyobjectYesRequest body