Skip to main content
POST
Create an invite

Authorizations

slog-api-key
string
header
required

API key obtained from the Slog dashboard or returned by the signup/invite-redeem flows. Pass as the slog-api-key header.

Body

application/json
email
string<email>
required
role
enum<string>

Workspace role for the invitee. Defaults to MEMBER. Cannot be OWNER.

Available options:
MEMBER,
ADMIN
Example:

"MEMBER"

teamRole
enum<string>

Role of a user within a team.

Available options:
VIEWER,
MEMBER,
ADMIN,
OWNER
teamIds
string[]

Teams to add the invitee to upon acceptance.

Example:

Response

Invite created and email sent.

invite
object