Your suggested change has been received. Thank you.

close

Mail API (0.1.0)

Download OpenAPI specification:Download

With this API you can send templated emails.

Mail API

Send invitation email

Sends an email to invite the receiver to a Relationship.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

Request Body schema: application/json
from
required
string

The email address of the sender of the email. This must be a verified domain.

to
required
string

The email address of the receiver of the email.

name
required
string

The name to address the receiver of the email.

application
required
string

A human-readable name for the application to which the user is invited.

actionUrl
required
string

The URL to which the user will be redirected when accepting the invitation.

template
string
Default: "relationship-invitation"

The template to be used for the invitation.

Responses

Request samples

Content type
application/json
{
  • "from": "string",
  • "to": "string",
  • "name": "string",
  • "application": "string",
  • "actionUrl": "string",
  • "template": "relationship-invitation"
}