POST
/
connect
/
magic-link

Authorizations

x-apikey
string
header
required
x-connection-id
string
header
required

Body

application/json
connectorConfigDisplayName
string | null

Filter connector config by displayName

connectorConfigId
string

Must start with 'ccfg_'

connectorName
string | null

Filter connector config by connector name

customerId
string

Anything that uniquely identifies the customer that you will be sending the magic link to

Minimum length: 1
displayName
string | null

What to call user by

redirectUrl
string | null

Where to send user to after connect / if they press back button

showExisting
boolean
default:
true
validityInSeconds
number
default:
2592000

How long the magic link will be valid for (in seconds) before it expires

Response

200 - application/json
url
string
required