Skip to main content
POST
/
invites
Create an invite
curl --request POST \
  --url https://slog.ai/invites \
  --header 'Content-Type: application/json' \
  --header 'slog-api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "role": "MEMBER",
  "teamRole": "MEMBER",
  "teamIds": [
    "team_01jqteam0001"
  ]
}
'
{
  "invite": {
    "id": "inv_01jqinvite001",
    "email": "[email protected]",
    "teamIds": [
      "team_01jqteam0001"
    ],
    "createdAt": "2026-05-15T10:00:00.000Z",
    "invitedBy": {
      "id": "user_01jquser0001",
      "name": "Alex Johnson",
      "email": "[email protected]",
      "avatarUrl": null,
      "humanId": null
    }
  }
}

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:
["team_01jqteam0001"]

Response

Invite created and email sent.

​
invite
object