/gleap-engagement-outbound | Type: Application | PCID required: Yes
Tools
gleap_engagement_outbound_create_banner
Create a new banner Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
gleap_engagement_outbound_create_chat_message
Create a new chat message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
gleap_engagement_outbound_create_engagement_email
Create a new email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
gleap_engagement_outbound_create_engagement_push_notification
Create a new push notification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
gleap_engagement_outbound_create_whatsapp_message
Create a new whatsapp message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
gleap_engagement_outbound_delete_banner
Delete an banner Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bannerId | string | Yes | — | Banner Id |
gleap_engagement_outbound_delete_chat_message
Delete an chat message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chatMessageId | string | Yes | — | Chat Message Id |
gleap_engagement_outbound_delete_email
Delete an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engagementEmailId | string | Yes | — | Engagement Email Id |
gleap_engagement_outbound_delete_push_notification
Delete a push notification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pushNotificationId | string | Yes | — | Push Notification Id |
gleap_engagement_outbound_delete_whatsapp_message
Delete a whatsapp message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
whatsappMessageId | string | Yes | — | Whatsapp Message Id |
gleap_engagement_outbound_get_banner
Get an banner Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bannerId | string | Yes | — | Banner Id |
gleap_engagement_outbound_get_banners
Get all bannersgleap_engagement_outbound_get_chat_message
Get an chat message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chatMessageId | string | Yes | — | Chat Message Id |
gleap_engagement_outbound_get_chat_messages
Get all chat messagesgleap_engagement_outbound_get_email
Get an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engagementEmailId | string | Yes | — | Engagement Email Id |
gleap_engagement_outbound_get_emails
Get all emailsgleap_engagement_outbound_get_push_notification
Get a push notification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pushNotificationId | string | Yes | — | Push Notification Id |
gleap_engagement_outbound_get_push_notifications
Get all push notificationgleap_engagement_outbound_get_whatsapp_message
Get a whatsapp message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
whatsappMessageId | string | Yes | — | Whatsapp Message Id |
gleap_engagement_outbound_get_whatsapp_messages
Get all whatsapp messagegleap_engagement_outbound_send_email_preview
Send email preview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engagementEmailId | string | Yes | — | Engagement Email Id |
emails | any[] | Yes | — | The emails value |
lang | string | No | — | The lang value |
gleap_engagement_outbound_send_whatsapp_template_message
Send a whatsapp template message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelId | string | Yes | — | The WhatsApp channel ID from your project |
customValues | object | No | — | Construct a type with a set of properties K of type T |
languageCode | string | No | — | Language code (e.g. “en_US”). Falls back to the contact’s language or “en_US” |
templateName | string | Yes | — | Name of the WhatsApp template registered with Meta |
to | string | Yes | — | Recipient phone number (E.164 format, e.g. “+14155552671”) |
gleap_engagement_outbound_update_banner
Update an banner Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bannerId | string | Yes | — | Banner Id |
body | object | Yes | — | Request body |
gleap_engagement_outbound_update_chat_message
Update an chat message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chatMessageId | string | Yes | — | Chat Message Id |
body | object | Yes | — | Request body |
gleap_engagement_outbound_update_engagement_email
Update an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engagementEmailId | string | Yes | — | Engagement Email Id |
body | object | Yes | — | Request body |
gleap_engagement_outbound_update_engagement_push_notification
Update a push notification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pushNotificationId | string | Yes | — | Push Notification Id |
body | object | Yes | — | Request body |
gleap_engagement_outbound_update_whatsapp_message
Update a whatsapp message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
whatsappMessageId | string | Yes | — | Whatsapp Message Id |
body | object | Yes | — | Request body |

