⚠️ 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 invitation

post/invite

Invites people to Glean via email or Slack

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

Invite request

channel
string (CommunicationChannel)
Enum: "COMMUNICATION_CHANNEL_EMAIL" "COMMUNICATION_CHANNEL_SLACK"
object (PeopleFilters)
Array of objects (Person)

The people who should receive this invite

template
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"
Responses
200

OK

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "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"
    }
}