⚠️ This documentation pertains to a preview endpoint. This feature is not yet ready for API consumption and may change.
For inquiries or feedback, please contact us at Glean.

Send support email

post/support

Sends a support email based on a template to the Glean support team.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

Support request

emailTemplate
required
string (CommunicationTemplate)

The type of email to send

Enum: "ADMIN_ALERT" "ADMIN_ALERT_V2" "ADMIN_INVITE" "ASSISTANT_ACCESS" "AUTO_INVITE" "CHAT_FEEDBACK" "CUSTOM_JSON_REPORT" "DLP_REPORT_NOTIFICATION" "DOMAIN_VERIFICATION" "GENERAL_FEEDBACK" "INVITE_REMINDER" "MANAGER_INVITE" "ONBOARDING_CHAT" "ONBOARDING_INTRO" "ONBOARDING_EXPLORE" "ONBOARDING_EXPLORE_EXTENSION_PROMO" "ONBOARDING_TIPS" "ONBOARDING_TIPS_EXTENSION_PROMO" "ONBOARDING_SURVEY" "ONBOARDING_ADMIN_INVITE" "RECRAWL_DATASOURCE" "REPORT_ISSUE_FEEDBACK" "SEARCH_FEEDBACK" "TEAMMATE_INVITE" "VERIFICATION_REQUEST" "VERIFICATION_REQUEST_NONUSER" "WEEKLY_FEED" "WORKSPACE_INITIALIZED" "CHANNELS_DIGEST_REMINDER" "CHANNELS_DIGEST_SIGNUP_REMINDER"
object (AlertData)

Admin alert related information that is used to construct the admin alert email

object

For building complex email UIs, we use a block structure that dictates what we create in the UI

Array of objects (Person)

The people to CC for each email

object

Payload for chat feedback reporting. Required when template is CHAT_FEEDBACK.

companyName
string

Name of the company.

datasourceInstance
string

The instance ID of the datasource (if any)

object (DlpReportData)

Dlp report metadata which is used to construct report email

Array of objects (Document)

The documents this email request refers to

object

Optional payload for feedback reporting.

object (OnboardingAdminInviteData)
reasons
Array of strings

Reasons this email request was sent. Will be shown directly to end user.

object (PeopleFilters)
Array of objects (Person)

The people to send emails to

Array of objects (Person)

The people who triggered this email

serverUrl
string

The URL of the QE instance the email request is processed by.

object

Mapping of recipientIds to the email subject they are to receive. Optional and only meant for templates with Sendgrid subject set to {{subject}}

unsubscribeUrl
string

The URL to unsubscribe from emails.

webAppUrl
string

The URL of the client triggering the request, as received in the ClientConfig

Responses
200

OK

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "emailTemplate": "ADMIN_ALERT",
  • "alertData": {
    • "bannerType": "ACTION_REQUIRED",
    • "bannerText": "string",
    • "alertDescription": "string",
    • "relevanceDescription": "string",
    • "resolutionStepsDescription": "string",
    • "resolutionSteps": [
      • {
        • "stepText": "string",
        • "link": "string",
        • "metadata": [
          • "string"
          ]
        }
      ],
    • "helpLink": "string",
    • "name": "string",
    • "triggeredTime": "2019-08-24T14:15:22Z",
    • "projectName": "string",
    • "datasource": "string",
    • "instanceDisplayName": "string",
    • "instanceName": "string",
    • "emailSubjectDescription": "string"
    },
  • "recipients": [
    • {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      }
    ],
  • "ccRecipients": [
    • {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      }
    ],
  • "recipientFilters": {
    • "filter": [
      • {
        • "fieldName": "type",
        • "values": [
          • {
            • "value": "Spreadsheet",
            • "relationType": "EQUALS"
            },
          • {
            • "value": "Presentation",
            • "relationType": "EQUALS"
            }
          ]
        }
      ],
    • "query": "string"
    },
  • "companyName": "string",
  • "datasourceInstance": "string",
  • "senders": [
    • {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      }
    ],
  • "webAppUrl": "string",
  • "serverUrl": "string",
  • "unsubscribeUrl": "string",
  • "documents": [
    • {
      • "id": "string",
      • "datasource": "string",
      • "connectorType": "API_CRAWL",
      • "docType": "string",
      • "content": {
        • "fullTextList": [
          • "string"
          ]
        },
      • "containerDocument": { },
      • "parentDocument": { },
      • "title": "string",
      • "url": "string",
      • "metadata": {
        • "container": "container",
        • "parentId": "JIRA_EN-1337",
        • "createTime": "2000-01-23T04:56:07.000Z",
        • "datasource": "datasource",
        • "author": {
          • "name": "name"
          },
        • "documentId": "documentId",
        • "updateTime": "2000-01-23T04:56:07.000Z",
        • "mimeType": "mimeType",
        • "objectType": "Feature Request",
        • "components": [
          • "Backend",
          • "Networking"
          ],
        • "status": [
          • "Done"
          ],
        • "customData": {
          • "someCustomField": "someCustomValue"
          }
        },
      • "sections": [
        • {
          • "title": "string",
          • "url": "string"
          }
        ]
      }
    ],
  • "reasons": [
    • "string"
    ],
  • "blocks": {
    • "property1": [
      • { }
      ],
    • "property2": [
      • { }
      ]
    },
  • "subjects": {
    • "property1": "string",
    • "property2": "string"
    },
  • "feedbackPayload": {
    • "comments": "string",
    • "customJson": "{\"comment\": \"glean is awesome!\", \"sender\": \"happycustomer@customer.com\"}",
    • "imageUrls": [
      • "string"
      ],
    • "issueType": "string",
    • "query": "string",
    • "trackingToken": "string",
    • "url": "string",
    • "ratingKey": "string"
    },
  • "chatFeedbackPayload": {
    • "rating": "string",
    • "comments": "string",
    • "previousMessages": [
      • "string"
      ]
    },
  • "dlpReportData": {
    • "frequency": "WEEKLY",
    • "requestTime": "2019-08-24T14:15:22Z",
    • "reportName": "string",
    • "status": "SUCCESS"
    },
  • "onboardingAdminInviteData": {
    • "isTrial": true,
    • "recipientData": [
      • {
        • "recipientEmail": "string",
        • "roleDisplayName": "string"
        }
      ]
    }
}