curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/support \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": "2023-11-07T05:31:56Z",
    "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": {},
  "subjects": {},
  "feedbackPayload": {
    "comments": "<string>",
    "customJson": "{\"comment\": \"glean is awesome!\", \"sender\": \"happycustomer@customer.com\"}",
    "imageUrls": [
      "<string>"
    ],
    "issueType": "<string>",
    "issues": [
      "<string>"
    ],
    "query": "<string>",
    "trackingToken": "<string>",
    "url": "<string>",
    "ratingKey": "<string>"
  },
  "chatFeedbackPayload": {
    "rating": "<string>",
    "issues": [
      "<string>"
    ],
    "comments": "<string>",
    "previousMessages": [
      "<string>"
    ],
    "chatTranscript": [
      {
        "timestamp": 123,
        "agent": "<string>",
        "userQuery": "<string>",
        "searchQuery": "<string>",
        "resultDocuments": [
          {
            "title": "<string>",
            "url": "<string>"
          }
        ],
        "response": "<string>"
      }
    ]
  },
  "dlpReportData": {
    "frequency": "WEEKLY",
    "requestTime": "2023-11-07T05:31:56Z",
    "reportName": "<string>",
    "status": "SUCCESS"
  },
  "onboardingAdminInviteData": {
    "isTrial": true,
    "recipientData": [
      {
        "recipientEmail": "<string>",
        "roleDisplayName": "<string>"
      }
    ]
  }
}'

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Scio-Actas
string

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

X-Glean-Auth-Type
string

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

Body

application/json
Support request

A request to send email[s] to the specified users

emailTemplate
enum<string>
required

The type of email to send

Available options:
ADMIN_ALERT,
ADMIN_ALERT_V2,
ADMIN_INVITE,
AGENT_MESSAGE,
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
alertData
object

All information related to an admin alert

recipients
object[]

The people to send emails to

ccRecipients
object[]

The people to CC for each email

recipientFilters
object

Filters that define the set of users that should be recipients of the email

companyName
string

Name of the company.

datasourceInstance
string

The instance ID of the datasource (if any)

senders
object[]

The people who triggered this email

webAppUrl
string

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

serverUrl
string

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

unsubscribeUrl
string

The URL to unsubscribe from emails.

documents
object[]

The documents this email request refers to