Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /gleap-engagement-inapp | Type: Application | PCID required: Yes
gleap_engagement_inapp_clone_engagement
Clone engagement
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
engagementId | string | Yes | — | Engagement Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engagementId": {
"type": "string",
"description": "Engagement Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"engagementId",
"body"
]
}
gleap_engagement_inapp_create_checklist
Create a new checklist
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
gleap_engagement_inapp_create_cobrowse_product_tour
Create a new cobrowse product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
gleap_engagement_inapp_create_engagement_product_tour
Create a new product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
gleap_engagement_inapp_create_modal
Create a new modal
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
gleap_engagement_inapp_create_news_article
Create a new engagement news article
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
gleap_engagement_inapp_create_survey
Create a new survey
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
Create a new tooltip
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
gleap_engagement_inapp_delete_checklist
Delete a checklist
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
checklistId | string | Yes | — | Checklist Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checklistId": {
"type": "string",
"description": "Checklist Id"
}
},
"required": [
"PCID",
"checklistId"
]
}
gleap_engagement_inapp_delete_cobrowse_product_tour
Delete an cobrowse product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
cobrowseProductTourId | string | Yes | — | Cobrowse Product Tour Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cobrowseProductTourId": {
"type": "string",
"description": "Cobrowse Product Tour Id"
}
},
"required": [
"PCID",
"cobrowseProductTourId"
]
}
gleap_engagement_inapp_delete_modal
Delete a modal
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
modalId | string | Yes | — | Modal Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modalId": {
"type": "string",
"description": "Modal Id"
}
},
"required": [
"PCID",
"modalId"
]
}
gleap_engagement_inapp_delete_news_article
Delete a news article.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
newsId | string | Yes | — | News Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"newsId": {
"type": "string",
"description": "News Id"
}
},
"required": [
"PCID",
"newsId"
]
}
gleap_engagement_inapp_delete_product_tour
Delete a product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productTourId | string | Yes | — | Product Tour Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"productTourId": {
"type": "string",
"description": "Product Tour Id"
}
},
"required": [
"PCID",
"productTourId"
]
}
gleap_engagement_inapp_delete_survey
Delete a survey
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
Delete a tooltip
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
tooltipId | string | Yes | — | Tooltip Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tooltipId": {
"type": "string",
"description": "Tooltip Id"
}
},
"required": [
"PCID",
"tooltipId"
]
}
gleap_engagement_inapp_export_survey_responses
Export survey responses
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
gleap_engagement_inapp_find_engagement_recipients
Find engagement recipients
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
engagementId | string | Yes | — | Engagement Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engagementId": {
"type": "string",
"description": "Engagement Id"
}
},
"required": [
"PCID",
"engagementId"
]
}
gleap_engagement_inapp_get_activities
Get engagement activities
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
engagementId | string | Yes | — | Engagement Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engagementId": {
"type": "string",
"description": "Engagement Id"
}
},
"required": [
"PCID",
"engagementId"
]
}
gleap_engagement_inapp_get_activities_count
Get engagement activities count
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
engagementId | string | Yes | — | Engagement Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engagementId": {
"type": "string",
"description": "Engagement Id"
}
},
"required": [
"PCID",
"engagementId"
]
}
gleap_engagement_inapp_get_checklist
Get a checklist
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
checklistId | string | Yes | — | Checklist Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checklistId": {
"type": "string",
"description": "Checklist Id"
}
},
"required": [
"PCID",
"checklistId"
]
}
gleap_engagement_inapp_get_checklists
Get all checklists
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_engagement_inapp_get_cobrowse_product_tour
Get an cobrowse product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
cobrowseProductTourId | string | Yes | — | Cobrowse Product Tour Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cobrowseProductTourId": {
"type": "string",
"description": "Cobrowse Product Tour Id"
}
},
"required": [
"PCID",
"cobrowseProductTourId"
]
}
gleap_engagement_inapp_get_cobrowse_product_tours
Get all cobrowse product tours
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_engagement_inapp_get_fixed_audience_samples
Get engagement fixed audience samples
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
engagementId | string | Yes | — | Engagement Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engagementId": {
"type": "string",
"description": "Engagement Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"engagementId",
"body"
]
}
gleap_engagement_inapp_get_modal
Get a modal
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
modalId | string | Yes | — | Modal Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modalId": {
"type": "string",
"description": "Modal Id"
}
},
"required": [
"PCID",
"modalId"
]
}
gleap_engagement_inapp_get_modals
Get all modals
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_engagement_inapp_get_news_article
Get an engagement news article
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
newsId | string | Yes | — | News Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"newsId": {
"type": "string",
"description": "News Id"
}
},
"required": [
"PCID",
"newsId"
]
}
gleap_engagement_inapp_get_news_articles
Get all engagement news articles
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
withoutChangelogs | string | No | — | Without Changelogs |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"withoutChangelogs": {
"type": "string",
"description": "Without Changelogs"
}
},
"required": [
"PCID"
]
}
gleap_engagement_inapp_get_product_tour
Get a product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productTourId | string | Yes | — | Product Tour Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"productTourId": {
"type": "string",
"description": "Product Tour Id"
}
},
"required": [
"PCID",
"productTourId"
]
}
gleap_engagement_inapp_get_product_tours
Get all product tours
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_engagement_inapp_get_statistics
Get engagement statistics
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
engagementId | string | Yes | — | Engagement Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engagementId": {
"type": "string",
"description": "Engagement Id"
}
},
"required": [
"PCID",
"engagementId"
]
}
gleap_engagement_inapp_get_survey
Get a survey
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
gleap_engagement_inapp_get_survey_response_samples
Get all survey response samples
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
gleap_engagement_inapp_get_survey_responses
Get all survey responses
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
gleap_engagement_inapp_get_surveys
Get all survey
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
Get a tooltip
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
tooltipId | string | Yes | — | Tooltip Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tooltipId": {
"type": "string",
"description": "Tooltip Id"
}
},
"required": [
"PCID",
"tooltipId"
]
}
Get all tooltip
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_engagement_inapp_mark_survey_responses_as_read
Mark all survey responses as read
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
gleap_engagement_inapp_summarize_survey_responses
Summarize survey responses
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
gleap_engagement_inapp_update_checklist
Update a checklist
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
checklistId | string | Yes | — | Checklist Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checklistId": {
"type": "string",
"description": "Checklist Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"checklistId",
"body"
]
}
gleap_engagement_inapp_update_cobrowse_product_tour
Update an cobrowse product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
cobrowseProductTourId | string | Yes | — | Cobrowse Product Tour Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cobrowseProductTourId": {
"type": "string",
"description": "Cobrowse Product Tour Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"cobrowseProductTourId",
"body"
]
}
gleap_engagement_inapp_update_engagement_product_tour
Update a product tour
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productTourId | string | Yes | — | Product Tour Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"productTourId": {
"type": "string",
"description": "Product Tour Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"productTourId",
"body"
]
}
gleap_engagement_inapp_update_modal
Update a modal
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
modalId | string | Yes | — | Modal Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modalId": {
"type": "string",
"description": "Modal Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"modalId",
"body"
]
}
gleap_engagement_inapp_update_news_article
Update a news article.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
newsId | string | Yes | — | News Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"newsId": {
"type": "string",
"description": "News Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"newsId",
"body"
]
}
gleap_engagement_inapp_update_survey
Update a survey
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
surveyId | string | Yes | — | Survey Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"surveyId",
"body"
]
}
Update a tooltip
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
tooltipId | string | Yes | — | Tooltip Id |
body | object | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tooltipId": {
"type": "string",
"description": "Tooltip Id"
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"tooltipId",
"body"
]
}