Skip to main content
POST
/
sources
/
invite
Source Invite
curl --request POST \
  --url https://api.streamkap.com/sources/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to_email": "<string>",
  "message": "<string>",
  "connectorType": "<string>",
  "returnUrl": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Source Invite body

​
to_email
string
required

Email address of the user to invite

​
message
string
required

Custom message to include in the invitation

​
connectorType
string
required

Type of connector being shared

​
returnUrl
string | null

URL to redirect to after invitation is accepted

Response

Successful Response