Skip to main content
Create Magic Link
curl --request POST \
  --url https://api.rampartcorporation.com/v2/magic-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --data '
{
  "email": "test@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "client_name": "Acme Inc"
}
'
{
  "url": "https://partner.rampartcorporation.com/magic-link?token=1234567890"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Headers

​
x-client-id
string
required

Client ID for authentication

Body

application/json
​
email
string
required

Email address to send the magic link to.

Example:

"test@example.com"

​
first_name
string

First name of the user.

Example:

"John"

​
last_name
string

Last name of the user.

Example:

"Doe"

​
client_name
string

Name of the client.

Example:

"Acme Inc"

Response

200 - application/json

Successfully created magic link

​
url
string

The URL of the magic link.

Example:

"https://partner.rampartcorporation.com/magic-link?token=1234567890"