curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "COMMUNICATION_CHANNEL_EMAIL",
  "template": "ADMIN_ALERT",
  "recipients": [
    {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    }
  ],
  "recipientFilters": {
    "filter": [
      {
        "fieldName": "type",
        "values": [
          {
            "value": "Spreadsheet",
            "relationType": "EQUALS"
          },
          {
            "value": "Presentation",
            "relationType": "EQUALS"
          }
        ]
      }
    ],
    "query": "<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
Invite request

A request to send an invite to the specified user[s]

channel
enum<string>

The channel that the invite is sent through

Available options:
COMMUNICATION_CHANNEL_EMAIL,
COMMUNICATION_CHANNEL_SLACK
template
enum<string>

The template of the invite message 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
recipients
object[]

The people who should receive this invite

recipientFilters
object

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

Response

200

OK